Upgrade to Pro — share decks privately, control downloads, hide ads and more …

What Changed & Why

What Changed & Why

A presentation on how to craft great Git commits.

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

Brett Chalupa

August 10, 2021
Tweet

More Decks by Brett Chalupa

Other Decks in Programming

Transcript

  1. Brett Ch a lup a , 2021 What Changed &

    Why The V a lue of Gre a t Git Commits
  2. The code di ff explains what changed. It’s up to

    us to explain why the change was made.
  3. 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
  4. Ideally, each commit should be atomic. This means it exists

    on its own, the tests past, and it encapsulates a speci fi c change.
  5. 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.
  6. Commits that are too small are noisy and trivial, making

    it di ff i cult to see the bigger picture.