BlueWallet/CONTRIBUTING.md
2020-06-17 11:21:20 +01:00

16 lines
842 B
Markdown

All commits should have one of the following prefixes: REL, FIX, ADD, TST, OPS, DOC. For example `"ADD: new feature"`.
Adding new feature is ADD, fixing a bug is FIX, something related to infrastructure is OPS etc.
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: `./scripts/edit-version-number.sh`)
In the commit where you up version you can have the commit message as
`"REL vX.X.X: Summary message"`.
Do *not* add new dependencies. Bonus points if you manage to actually remove a dependency.