From e4c7bafd276049c805039b240e0a83346c31f41b Mon Sep 17 00:00:00 2001 From: Ruben Beltran del Rio Date: Sun, 20 Sep 2020 16:55:36 +0200 Subject: Initial release --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') 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/ -- cgit