BlueWallet/CONTRIBUTING.md

28 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2023-12-01 19:40:26 +01:00
## Commits
2023-09-14 12:42:27 +02:00
All commits should have one of the following prefixes: REL, FIX, ADD, REF, 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. REL is for releases, REF is for
refactoring, DOC is for changing documentation (like this file).
2020-04-06 14:06:48 +02:00
Commits should be atomic: one commit - one feature, one commit - one bugfix etc.
2023-12-01 19:40:26 +01:00
## Releases
2020-04-06 14:06:48 +02:00
When you tag a new release, use the following example:
2021-09-24 15:14:41 +02:00
`git tag -m "REL v1.4.0: 157c9c2" v1.4.0 -s`
2020-04-06 14:06:48 +02:00
You may get the commit hash from git log. Don't forget to push tags `git push origin --tags`
2021-09-24 15:14:41 +02:00
Alternative way to tag: `git tag -a v6.0.0 2e1a00609d5a0dbc91bcda2421df0f61bdfc6b10 -m "v6.0.0" -s`
2020-12-17 14:53:08 +01:00
2020-06-17 12:21:20 +02:00
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`)
2020-04-06 14:06:48 +02:00
In the commit where you up version you can have the commit message as
`"REL vX.X.X: Summary message"`.
2020-06-17 12:21:20 +02:00
2023-12-01 19:40:26 +01:00
## Guidelines
2020-06-17 12:21:20 +02:00
Do *not* add new dependencies. Bonus points if you manage to actually remove a dependency.
2023-09-14 12:42:27 +02:00
All new files must be in typescript. Bonus points if you convert some of the existing files to typescript.
2023-12-01 19:40:26 +01:00
New components must go in `components/`. Bonus points if you refactor some of old components in `BlueComponents.js` to separate files.