|
|
|
|
|
|
by indiv0
3716 days ago
|
|
|
I like to write my commits in the Angular conventional-changelog format [0]. In particular, it looks like this: <type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Where `<type>` is the type of change (e.g. `feat` for a feature or `docs` for doc updates), `<scope>` is the scope of a change, `<subject>` is the subject line, with the first letter uncapitalized, `<body>` being an explanation of the change in imperative, present tense, and the `<footer>` containing information about breaking changes and any issues the commit closes.I like it because I find that adhering to this style lets me have a nice seat of easy to read commits which explain their purpose and scope clearly. Also, it lets me use a tool like `clog-cli` [1] to generate pretty changelogs [2] automatically! The only nitpick I have with this style is the fact that they recommend not capitalizing the first letter of the subject line. This means that, for example, in emails or when creating a PR, I have to capitalize the summary so that it looks correct. Minor, but annoying. [0]: https://github.com/conventional-changelog/conventional-chang... [1]: https://github.com/clog-tool/clog-cli [2]: https://github.com/clog-tool/clog-cli/blob/master/changelog.... |
|
|