Add a CONTRIBUTING.md to Graphviz
I think Graphviz needs more contributors to be a sustainable project. I propose we should therefore prioritise onboarding of new contributors, by making it clear and transparent how to contribute.
There's emerging standard of a CONTRIBUTING.md
that goes over how to contribute, how the project accepts and reviews changes, expectations around testing and commit messages, and perhaps even what we're looking for help with.
We already have DEVELOPERS.md
which is mainly aimed at established contributors. I was thinking of something more aimed at newbies.
Some materials for how to set one up:
- https://mozillascience.github.io/working-open-workshop/contributing/
- https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
- https://embeddedartistry.com/blog/2017/12/11/get-others-involved-in-your-project-with-a-contributing-guide/
Examples (more or less randomly chosen)
- https://github.com/github/docs/blob/main/CONTRIBUTING.md
- https://github.com/google/docsy/blob/master/CONTRIBUTING.md
- https://github.com/atom/atom/blob/master/CONTRIBUTING.md
- https://github.com/microsoft/vscode/blob/main/CONTRIBUTING.md
- https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md
Edited by Mark Hansen