Add CONTRIBUTING.md to help people get started
Created by: skylerberg
Since I am figuring out how to best contribute (figure it out slowly due to very limited time at the moment), it seems like documenting what I learn would be a good idea. Post in this thread if you have ideas for what I should include in this document. Here is what I plan on writing about so far:
- Communication on slack
- GitHub issues
- Fork/merge workflow (brief overview)
- Continuous integration setup
Things I will include but need other people to clarify:
- Testing practices: Do we have testing practices beyond making sure it compiles? Are they run automatically? Are new commits expected to have tests for certain parts of the code base?
- Style guidelines: Are there any? Do we use any linting tools? Any guidelines for commit messages?
- Interactions with other projects: There are some other projects under the redox-os group on GitHub, how do they relate?
- Applications vs kernel: Not exactly sure what I want to know here, but I feel like there is something to write about this.
- Low-hanging fruit: What are easy targets for newbies?
The document needs to be informative and welcoming, so that is what I will aim for. I would love to hear feedback on what I should include. Thanks!