padawan-wallet
padawan-wallet copied to clipboard
Format For Commit Messages
I tried a few different things on this repo for the first 1000 commits (using conventional commits for example), and I am looking to clean up the approach we use for the next 1000!
Commit message standards are of course arbitrary, but a big part of the value comes from using a common approach (rather than a single approach being better than others), particularly on open source codebases where many developers come together to write the code.
This issue will outline what I'm looking for in commits moving forward now that we've tried a few different things over the past 6 months.
Commit Format
- If the commit targets only one of the 2 apps, the commit message will start with square brackets with an identifier for the app it targets. Examples:
[iOS],[Android]. Note that if the commit is related to docs, CI, or other common parts of the codebase they do not need this qualifier. - The commit message will start with a capital letter, i.e.
[Android] Fix app bar on wallet screen - The commit message will not contain a full stop at the end of the sentence.
- Preferably, the commit message uses an "active" sentence stucture, akin to finishing the sentence "if this commit is applied, it will...
Add new lesson on hardware wallets" instead of the passive form "Added a new lesson screen.