This will be a quick and short post, so feel free to spare a minute to read how I summarize changes within my code, and what style guide I’m referring to.
This will work for both commit messages and PR/MR titles. I’ve been following this style guide ever since I started writing my own library, check out Aqua and Scramble. There might be a couple of changes between then, but it stays the same overall.
feat: add syntax highlighting
│ └── Summary in present tense and imperative form
└────── Type: chore | docs | feat | fix | refactor | style | test
I used to write them like title, with a capitalized letter at the beginning. But, as I find out more about other repositories, most of them uses all lowercase characters. If you need a strict guidance in your repository for your team or anyone contributing, you can set up commitlint. Unfortunately, it only works with Node projects, so you’ll need to have a
package.json. You can take a look at my
t.sapper template for an example on how it looks.
feat: (new feature for the user, not for a build script)
fix: (bug fix for the user, not a fix for build script)
refactor: (refactoring production code; renaming a variable, etc.)
docs: (changes to the documentation)
chore: (updating grunt tasks etc; no production code change)
style: (formatting, missing semi colons, etc; no production code change)
test: (adding missing tests, refactoring tests; no production code change)
This could also work for pull requests (PR) and merge requests (MR). Look up my references for more great examples!
It needs to be said, there are no right or wrong ways to write commit messages. Just like currencies or most things in this world, as long as the people agrees and accepts it as their currency, it will have its own value. The same goes for your commits, as long as you understand what the title means and what it changes, you can follow any style guides you want.
Find an issue with this post? Have something to add, update, or clarify? All my posts here are editable.
Just create a new Issue or PR on GitHub, any fix or addition is much appreciated!