Browse Source

Create CONTRIBUTING.md

fiatinpt
Overtorment 5 years ago
committed by GitHub
parent
commit
568ac3f4a1
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 11
      CONTRIBUTING.md

11
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"`.
Loading…
Cancel
Save