Hey everyone! I'm diving into Git and GitHub and I'm curious about the best practices for writing commit messages. Often, I just say things like 'I did XYZ' or 'I added an image of a cow with changes to XYZ.' But what should I be doing instead to make my commit messages clear and professional, especially in a work environment?
5 Answers
The expectations can vary based on your team's workflow. If you have a pull request process, then make sure your PR descriptions are descriptive, since commit messages mostly serve as a reference for you. So focus on what the merged changes entail, rather than a perfect commit message each time.
Don’t forget to include why you made changes too! A commit can show what was done, but providing reasoning helps others understand your decision-making process better.
I'm a fan of the Conventional Commits approach, especially when paired with meaningful pull requests. Your commit should ideally be concise but impactful, like 'maint: replaced a static footer with a dynamic year lookup.' This gets bundled into a PR that has the full context of what the change achieves, making it super clear for anyone who looks back at it.
A lot of people tie commit messages to specific tickets, like 'ZOO-123: Fixed RabbitMQ binder names.' This way, you can easily trace the commit back to the related task or issue. Some teams also follow the conventional commit format, which helps in maintaining a cleaner commit history. For instance, 'fix(ZOO-123): Corrected RabbitMQ binder names' clearly states what has been fixed. Keeping messages in imperative present tense is key, like saying 'Fix to' instead of 'Fixed.' Keep it concise and avoid verbiage; something like 'Added more changes' is way too vague. If you’ve moved to a new feature, you might say 'feat(SCHOOL-23): Introduced Japanese language support.' Check out the resources linked in this thread for more solid tips!
Thanks a ton for the detailed breakdown! This really clears things up for me on how to craft my commit messages. And wow, I can’t believe someone let their frustrations out in commit messages like that!
Every little change counts. I’ve committed even a single space change because it's all about tracking detailed progress—push that ASAP! Just make sure you're doing this work on your branch and submit with a pull request. It's all about supporting this agile process, maintaining clarity in the history.
Got it! So, it’s all about being clear with my PR descriptions for now. Just doing personal projects so far, but I see the importance.