loading...
Cover image for Links: Authoring commit messages

Links: Authoring commit messages

apetro profile image Andrew Petro ・1 min read

Great writing is intentional. It considers the needs and expectations of the reader.

Commit messages are writing.

Commit messages are great when they're intentional, considerate of the needs and expectations of the reader.

Who's the reader?

The reader is future you. Or future me. It's colleagues reviewing a Pull Request. It's a release engineer trying to verify and summarize the changes that will go into a release. It's someone troubleshooting trying to find when an unexpected change may have been introduced.

Write great commit messages. This post is less about directly telling you how to do this, and more a place where I can collect annotated links about this.

See also: my Pinboard tag commit_messages.

Cover photo credit: Photo by NihoNorway graphy on Unsplash

Discussion

pic
Editor guide