What Changed & Why

A presentation on how to craft great Git commits.

Watch the video: https://www.youtube.com/watch?v=4ool5Vn29cg

Transcript

1. Brett Ch a lup a , 2021 What Changed & Why The V a lue of Gre a t Git Commits
2. There’s more to creating Git commits than: git commit -m "Changed some stuff in Account"
3. By spending just a few moments cra ft ing commits, we can help Future Us.
4. The code di ff explains what changed. It’s up to us to explain why the change was made.
5. It’s about providing more context.
6. Great commits help those reviewing your code understand the changes.
7. Great commits help those in the future trying to understand why a change was made.
8. Great commits help fi x bugs quicker when using git blame and git bisect.
9. Crafting a Commit • What motivated the change • Any aspects of the implementation that are noteworthy • Oddities and exceptions and edge-cases you came across • Links to relevant conversations with the team • Link to your project management tool ticket • Links to any online resources and documentation that was instrumental in the commit Wh a t to include in a gre a t Git commit mess a ge
10. Ideally, each commit should be atomic. This means it exists on its own, the tests past, and it encapsulates a speci fi c change.
11. This can be di ff i cult to do at times, but it helps to break commits down into their smallest signi fi cant chunks.
12. Commits that are too large are di ff i cult to reason about.
13. Commits that are too small are noisy and trivial, making it di ff i cult to see the bigger picture.
14. Add hunks of code to the stage with: git add -p
15. Write your commit message with: git commit -v
16. Great Commit Examples
19. Demo