DEV Community

Discussion on: How to make good Git commits

Collapse
 
otomer profile image
Tomer Ovadia • Edited

Great article! Would also love to hear your thoughts about naming conventions around information included for branches and commits with the distinguish of task/bugfix/feature and how u tend to name these with the task/story number.

Collapse
 
ruanbrandao profile image
Ruan Brandão

I think it is perfectly fine to reference tasks/stories on the commit message, and I personally think the best way to do this is by referencing it on the commit message body (with a link to the issue manager for instance). But it is important to keep in mind that this should be an additional information and it does not remove the need of good commit messages.

Another important point to be aware here is that doing that will create a coupling between the project's commit history and the issue manager that the team is using, so migrating to a different issue manager will be a lot harder and can make a great part of the commit message lose its meaning.