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

docs: contributor development process #411

Open
7 tasks
andrew-codes opened this issue Jul 5, 2024 · 0 comments
Open
7 tasks

docs: contributor development process #411

andrew-codes opened this issue Jul 5, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@andrew-codes
Copy link
Owner

andrew-codes commented Jul 5, 2024

Reduce barrier for new contributors to get started and involved.

Outline ways to contribute; via discussions, opening issues, and contributing bug fixes or features. This can expand the contributor guide that already exists within the repo. Consider the following additions. This is a non-exhaustible list.

  • Contribution process
    • Fork repo, create branch, open pull request against this repo.
    • It may be valuable to note that the CI pipeline must be approved by a code owner prior to them running, so to align expectations that there may be a delay after opening a PR and having a green pipeline.
    • Convey PR requirements that must be fulfilled, such as test coverage, etc. Currently, the test coverage targets are in the codecov.yml file.
  • Ensure new contributors can set up a new local development environment via provided instructions. Are they clear or are there any improvements to be made to them; gotchas to be aware of, FAQ, etc.?
  • Communicate acceptable PR title and description bodies.
  • Include details about conventional commit usage on PR merge commits
  • Include details on how to relate a PR to an issue via Fixes #IssueNumber, Relates to #IssueNumber, etc.
  • Include details on git commit CLI wizard and usage of git-cz
@andrew-codes andrew-codes converted this from a draft issue Jul 5, 2024
@andrew-codes andrew-codes added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 5, 2024
@andrew-codes andrew-codes changed the title Document contributor development process docs: contributor development process Jul 5, 2024
@andrew-codes andrew-codes added this to the v5.0.0 milestone Jul 5, 2024
@andrew-codes andrew-codes removed this from the v5.0.0 milestone Jul 26, 2024
@andrew-codes andrew-codes modified the milestone: v5.0.0 Aug 11, 2024
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 good first issue Good for newcomers
Projects
Status: Ready 📝
Development

No branches or pull requests

1 participant