diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..48265f0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing to Grafn + +Improvement to the codebase are welcome: whether it's for documentation, +performance, legibility or to improve how useful it is. + +## How to contribute + +Above All: Be nice, always: with yourself and others. + +* Make sure the linter show no warnings or errors +* Make sure the tests continue passing +* Update the CHANGELOG according to [keep a changelog][keep-a-changelog] standard +* Update the README where appropriate +* Update the version following [semantic versioning][semver] +* Make the PRs directly to the master branch, and include context so we understand + why the contributions are being made. + +[semver]: https://semver.org/ +[keep-a-changelog]: https://keepachangelog.com/en/1.0.0/ |