From 568ac3f4a13baf514a15b3283202976dd372a4d9 Mon Sep 17 00:00:00 2001 From: Overtorment Date: Mon, 6 Apr 2020 13:06:48 +0100 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d136987d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +All commits should have one of the following prefixes: REL, FIX, ADD, TST, OPS, DOC. For example `"ADD: new feature"`. + +Commits should be atomic: one commit - one feature, one commit - one bugfix etc. + +When you tag a new release, use the following example: +`git tag -m "REL v1.4.0: 157c9c2" v1.4.0` +You may get the commit hash from git log. Don't forget to push tags `git push origin --tags` + +When tagging a new release, make sure to increment version in package.json and other files (we have a script for that: `./edit-version-number.sh`) +In the commit where you up version you can have the commit message as +`"REL vX.X.X: Summary message"`.