pH-7 / OutstandingGitPractices

OutstandingGitPractices™ contains a list of best practices to follow when using git. If you would like to become an outstanding dev, well, this is your guideline!

Home Page:https://dev.to/pierre/guideline-git-commit-2blb

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Outstanding Git Practices

The 2 most important guidelines when committing your code

Commit messages 📝

Commit messages play a big role in the understanding of every change. They should be in present tense, short, clear and explicit. They should clearly say what happened as well as the reason/motivation behind the change. Ask yourself “What are the changes done for?”. In another word “Why you did what you did?”. In short, the explanation that we don't necessarily see in the code diff of the commit.

Additionally, adding the ticket ID at the beginning of your commit message. Sometimes, we need to know the reason why a piece of code has been changed and need to dig into the ticket to have a full understanding of the feature requirements.


Git commits 🎨

✅ Each commit should be small and fix only one thing per commit, not more. Following this important rule, if your commit message contains the word and or +, that means you are trying to commit multiple changes in one commit and you shouldn’t ❌

This rule is not just there to be nice. When you need to revert or cherry-pick a commit from your git history, the fact that one commit only contains one specific update really helps.

About the Author 👨‍🍳

Pierre-Henry Soria. A super passionate and enthusiastic software engineer, and a true cheese & chocolate lover 💫

@phenrysay pH-7

Pierre-Henry Soria

About

OutstandingGitPractices™ contains a list of best practices to follow when using git. If you would like to become an outstanding dev, well, this is your guideline!

https://dev.to/pierre/guideline-git-commit-2blb