]> git.r.bdr.sh - rbdr/graphviz-to-grafn/blame_incremental - CONTRIBUTING.md
Initial version
[rbdr/graphviz-to-grafn] / CONTRIBUTING.md
... / ...
CommitLineData
1# Contributing to graphviz-to-grafn
2
3Improvement to the codebase are welcome: whether it's for documentation,
4performance, legibility or to improve how useful it is.
5
6## How to contribute
7
8Above All: Be nice, always: with yourself and others.
9
10* Make sure the linter show no warnings or errors
11* ~Make sure the tests continue passing~ there's no tests atm
12* Update the CHANGELOG according to [keep a changelog][keep-a-changelog] standard
13* Update the README where appropriate
14* Update the version following [semantic versioning][semver]
15* Make the PRs directly to the master branch, and include context so we understand
16 why the contributions are being made.
17
18[semver]: https://semver.org/
19[keep-a-changelog]: https://keepachangelog.com/en/1.0.0/