DEV Community

talent
talent

Posted on

Github commits.Why a good commit message is important?

When you work on a personal project your commits are yours but when you work on a team or contribute to open source. A well-crafted commit message can clearly communicate to other developers working on that project what you tried to perform with the codebase by just reading that message.
git commit -m "fix:( Authentication ) authorization issue in login page "

the structure of good commit is ๐Ÿ‘‡

" [optional scope]: "

๐Ÿ“ - of commit helps in understanding the nature of commit whether it is a Feature,Fix, Refactor etc.

๐Ÿ“ - can be used to categorize your commit, you can also use this to mention your folder name.

๐Ÿ“ : a short description for your commit.

this commit now can clearly give your teammate the context of what type of change you did, what is the scope change it has and a little description is like the cherry on the cake.

Hope this will help you in writing a better commit next time ๐Ÿ˜Š

Adding the links of a few standard commit conventions you can follow.

If you have used more good commit conventions other than those, just drop them in the comments.

Top comments (0)