Add CONTRIBUTING.md to repo
carolstran opened this issue · 0 comments
carolstran commented
As of now, all we have is a stand-in Contributing section of the README. It'd be great to have a more robust CONTRIBUTING.md file.
This file (generally) should contain the following...
- A thank you to potential contributors
- Table of Contents
- Code of Conduct
- What people should know before getting started
- How people can contribute
- Styleguides
- Pull request process
- Questions/getting in touch
For this repo, it could contain information on...
- Pulling any relevant info from README
- Branching, formatting & linting
- Commit message conventions
- Running tests
... and there's probably more I'm missing!
Some projects for inspo:
💖 Feel free to ask questions and be creative 💖