Add a bit of welcome and cheer at the top
Thank you for your interest in contributing to [Project] 🎉!
Restart your project vision here. Redundancy is your friend
[Project] is ...
Add some info on why people should read your contributor guidelines and what they are.
This documents is a set of guidelines for contributing to [Project] on GitHub. These are guidelines, not rules. This guide is meant to make it easy for you to get involved.
If your guide is long, consider adding a table of contents.
- Participation guidelines
- What we're working on
- How to submit changes
- How to report bugs
- Communication channels
This project adheres to a code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [EMAIL].
This is a good place to link your Roadmap, GitHub Milestones, or Projects so newcomers can see what you're working on.
Take a look at the issues in our current milestone or browse some good first bugs to get started!
Take a look at this Roadmapping exercise to start making your own milestones and issues. This will help newcomers (& MozFest attendees!) know where they can help.
Explain how you want contributors to propose changes. For an example GitHub workflow, see Node.js's instructions for code contributions.
Once you've identified one of the issues above that you feel you can contribute to, you're ready to make a change to the project repository!
- Fork this repository. This makes your own version of this project you can edit and use.
- Make your changes! You can do this in the GitHub interface on your own local machine. Once you're happy with your changes...
- Submit a pull request. This opens a discussion around your project and lets the project lead know you are proposing changes.
First time contributing to open source? Check out this free series, How to Contribute to an Open Source Project on GitHub.
Ask your contributors to stay on the lookout for can any potential issue that might cause problems for the project. These could be problems in code (if you’re creating software), content omissions or copy errors (if you’re creating a learning resource), or any issues with the functionality or design of your project.
Most projects invite all contributors to report bugs, so "debugging" or fixing problems happens quickly and with the input of the community. Take a look at Atom's example for how to teach people to report bugs to your project.
Notice a mistake? Please file any bugs, requests, or questions in our issue tracker [LINK TO ISSUE TRACKER]!
Do you have a chat room or email list you use to discuss this project? List them all here! Provide clear contact info, and outline the process for getting in touch, for anyone with questions.