Skip to content
← Learning guide

The Commit

← Back to study results
Other download formats

Activity 1 of 3

Leave a useful record

Create information that another person can understand and return to.

Illustrated study

Leaving a trace of a change

A computing logbook offers a historical comparison for the explanation attached to a software change.

A ruled logbook page containing handwritten times, calculations and relay notes, with a moth taped beside the entry for relay 70, panel F.

Figure 1 · 9 September 1947 (log entry)

Mark II logbook with a moth found in a relay

Read the times and component references as clues for another person. A software commit records a versioned change; this logbook is not one. What could a useful commit message borrow from the habit of recording what happened, where it happened and why it mattered?

Mark II operators; U.S. Navy photograph · Naval History and Heritage Command · object held by the Smithsonian
NH 96566-KN · Courtesy Naval Surface Warfare Center, Dahlgren, Virginia · Navy reproduction via Wikimedia Commons

View full size ↗Download image
Collection record and reuse rights

Display copies are resized and compressed. Source and license links apply to the image above.

Explore more museum and archive collections →

Software · The Commit

Explain a change to a future reader

Treat a commit message as a record of intent and consequence. Practice with an invented change, without editing a real repository.

Try this

Describe the problem, the change and the expected behavior in three sentences. Add the check that would show it worked.

Reflect

What decision would otherwise disappear from the record?

Take it further · optional follow-up

Write a follow-up note for a fictional reversal of the change. Explain which assumption proved wrong and what evidence should travel with that decision.

Compare with another activity · Conservation

The Archive: Describe how something can be found →

This opens a separate activity. Use Back to return to your sequence.

Prepared study prompt · not an editor-reviewed research article