Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contribution guide for Issue and PR #96

Open
2 tasks
wusatosi opened this issue Jan 6, 2025 · 1 comment
Open
2 tasks

Contribution guide for Issue and PR #96

wusatosi opened this issue Jan 6, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@wusatosi
Copy link
Member

wusatosi commented Jan 6, 2025

I was originally going to take this, but since I am focusing my time on inplace vector for Jan, I would love if someone can contribute something to get us started.

Goal: Provide a clear and intuitive contributor's guide for Pull Requests and Issue Creation. Utilize GitHub's Issue Template and Pull Request Template

Components:

  • Preferably both PR and issue template should be adopted from industry standard guidelines. But a clear and concise custom written guideline set would be fantastic as well.
  • Must include a link to code of conduct.
  • The guideline should provide a clear structure for reporting Issues/ providing PR.
  • The guideline should minimize the amount of clutter it will show when viewing as a maintainer/ reviewer (tip: you can hide guidelines in comments so only the PR author would see them when proposing the PR).
  • The guideline should encourage PR author to check if their change is in compliance to the beman standard.

Recommendations for PR guideline:

  • The guideline should encourage small & incremental PR

Recommendations for issue guideline:

  • The guideline should discourage link dump/ log dump without context.
  • The guideline should encourage use of labels.

Potential reference:

For tracking:

  • Issue template
  • PR template
@wusatosi wusatosi added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Jan 6, 2025
@wusatosi
Copy link
Member Author

wusatosi commented Jan 9, 2025

Include in contribution guide for README:

  1. Makesure the added info does not impact readability

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant