fettle
fettle copied to clipboard
Documentation
We should have:
- Code of conduct ✅
- License ✅
- Contributor guide ✅
- Issue template
- A gitter channel ✅
Other things:
- Developer getting started (need VS 2017, ...) ✅
- How it all works (technical details)
- Known issues - ✅
Consider using this README template https://gist.github.com/PurpleBooth/109311bb0361f32d87a2 - ✅
This looks like a good example of a Code of Contact: https://www.contributor-covenant.org/version/1/4/code-of-conduct.md
The Atom editor team use this. As is it requires a contact email address to be added.
The Atom Contributing Guide is very extensive, but there are parts that might be good to take out of this for a basic Fettle guide: https://github.com/atom/atom/blob/master/CONTRIBUTING.md