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.
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.
codecov.yml
file.Fixes #IssueNumber
,Relates to #IssueNumber
, etc.git-cz