Write something nice and instructive as an intro. Talk about what kind of contributions you are interested in.
If you're not looking for specific contributions, note that up front. For example:
Please, don't use the issue tracker for support questions. Instead use: a, b, or Stack Overflow.
If you have a code of conduct (CoC) document, include the expectation and link to the document. For example:
By contributing to this project, you agree to abide by our Code of Conduct. We expect all contributors to follow the Code of Conduct and to treat fellow humans with respect.
If there's not a separate document, include your CoC here.
Include links to additional resources, such as docs, bugs, and communication venues (developer listserv, emails, etc).
Provide information on the process for requsting new features. Do you have a specific label that should be applied? Is sign-off needed?
Share roadmap, goals, or development philosophies.
If you find a security vulnerability, do NOT open an issue. Email <[email protected]> instead.
Ask contributors to run a bug check before submitting any changes. Also ask them to read any existing bugs to ensure they're not creating duplicates.
Link to FAQs or debugging guides.
Include notes for how users can improve the documentation.
Should you have a suggestion for the documentation, you can open an issue and outline the problem or improvement you have - however, creating the doc fix yourself is much better!
If you want to help improve the docs, it's a good idea to let others know what you're working on to minimize duplication of effort. Create a new issue (or comment on a related existing one) to let others know what you're working on. If you're making a small change (typo, phrasing) don't worry about filing an issue first.
Provide instructions on buildling and viewing documentation
This section is used to get new contributors up and running with dependencies, development, testing, style rules, formatting rules, and other things they should know.
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of
<coding_language/dependency/requirement_1> - You have a
<Windows/Linux/Mac>machine. State which OS is supported/which is not. - You have read
<guide/link/documentation_related_to_project>.
Add the following to your .bash_profile configuration
# Include any keys or other configuration requirements
export KEY_NAME="<api_key>"What branches should be work be started off of? Include instructions on how to build the project.
Provide instructions for adding new tests. Provide instructions for running tests.
Include reference to any relevant style guides, particularly code-related. If you use a linter or another automatic checker, provide instructions on how to run it.
Working on your first pull request? Read the GitHub guide to pull requests.
How will you address feedback and what is your intention?
Once your PR is submitted, your changes will be reviewed and constructive feedback may be given. Feedback is meant to ensure the highest quality content makes it into this project, and changes will be approved once feedback has been addressed.
Do you have a mailing list, google group, slack channel, IRC channel? Link to them here.
How do you prefer people to ask questions? Via an issue? Is there an IRC channel, Google Group, or other way to get help? Should issues that are questions get a specific label? Can they email you directly?