06 Jul 2018

Resources for creating useful revision histories

I gave a talk at Brighton Ruby today on revision histories and code maintainability (You can watch the video here). Below are more resources on the same subject for those of you that want to go deeper.

Talks

Get Off the Tightrope by Tom Stuart: A great talk from Tom Stuart in which he outlines remedies and strategies for dealing with large problems, including advice on how history hygiene can help. Highly recommend.

Telling Stories Through Your Commits by Joel Chippindale: Another great talk, this time from Joel Chippendale of Future Learn covering similar ideas to those covered in my talk.

Git-driven Refactoring: Ashley’s talk from Brighton Ruby is a fantastic talk that demonstrates some of the other benefits that can come from a well put together revision history.

Blog posts

A Note About Git Commit Messages by Tim Pope: This for me is the canonical blog post on how to write good commit messages. Essential reading.

Small Commits for Fun and Profit Part 1 and Part 2: Two fantastic blog posts that detail how to shape commits using git add --patch, git commit --amend and git rebase --interactive.

10 Git tips You Didn’t Know You Needed: More tips, this time from myself. This is a write-up of a lightning talk I gave at my local Ruby meetup.

How to Write the Perfect Pull Request: Another great blog post on putting together the perfect pull request by Keavy.

Every line of code is always documented: Mislav’s post was instrumental in my understanding of the usefulness of a well put together history and the ways Git can be used to dig through one.

Other resources

Flight rules for Git: A comprehensive and succinct primer containing step-by-step actions for performing common Git actions.

Git Ready: Includes a breakdown of beginner/intermediate/advanced Git techniques, useful if you’re looking to learn something new to level up your Git abilities.

GIT.WTF!?: Similar to the flight rules, full of tips covering common problems and questions people face when working with Git.

Want more great content like this?

I send an email when I have a new tip or piece of insight to share. Drop your email in the box below to stay in the loop!