🚀CONTRIBUTING File
Also known as CONTRIBUTING.md, Contributing Guide, Contribution Guidelines
A file that tells people how to help with a project. It covers bugs and code.
Think of it like
It is like the rules sheet by a shared garden. It tells new helpers how to pitch in.
Example
Emma wants to fix a typo in a big project. The CONTRIBUTING file tells her to make a branch, run the tests and open a pull request.
Why it matters
New helpers know what to do, and maintainers get changes in the shape they need. Fewer pull requests get turned away.
Definition
Example code
markdown
## How to help
1. Fork the repo and make a branch.
2. Run npm test before you push.
3. Open a pull request with a short summary.Common mistake
Key takeaways
- 1How to help. Bugs, setup and changes.
- 2In the top folder. Named CONTRIBUTING.md.
- 3Linked by GitHub. Shown on new issues and pull requests.