Commit Message Convention - bounswe/2021SpringGroup12 GitHub Wiki

To make searching, reading and dealing with thousands of commits easily we need a commit message convention. The Angular Repo on Github has a very good commit message convention that we can edit to our usage.

<type>(<scope>): <short summary> #<issuenumber>

With this commit message template we can see the important info about the commit as such is it a bug or a feature? Is it about frontend work or backend work? And it includes a short summary as well. And finally a issue number to look for commits regarding a issue.

It also helps with modularization of commits. Since huge commits with thousands of file changes are hard to work with, we can divide them to scopes such as frontend/login-page or backend/goal/database etc.

Also we can use tools like GitHooks to write and run scripts to check and enforce this convention easily.

References

⚠️ **GitHub.com Fallback** ⚠️