Commit Messages

commit-messages.txt

Context

    The circumstances that form the setting for an event, statement, or
    idea, and in terms of which it can be fully understood and assessed.

When you are writing a commit message getting the context right is very
important.  Here are some pieces of information that are useful for
building up a proper context.

    * Explain what was done.

    * Justify your changes.

    * Show examples.

    * Share your notes.

    * Reference your sources.

NOTE: The above list is not an example of how a commit message should be
formatted, nor does it require you include all of the above information.
A commit message requires only enough inforamtion to rebuild the context
of the work being performed without forcing someone to look at the
changes.

Examples

    Minitest

	Tom Miller failing his own advice.
	https://github.com/seattlerb/minitest/pull/34

    Git

	Linus Torvalds move files builtin-* to buitin/*.
	git show -s 81b50f3ce40bfdd66e5d967bf82be001039a9a98

	Jonathan Nieder remove #!interpreter line from shell libraries
	git show -s 11d62145b904b81013d1ad558d68a74e22e81a91

    Gradesfirst

	Andrew Sellers introducing the "go" directory.
	git show -s f3baa75eae86fe2a9b1c169b770d78df70d06d2a

	Anthony Crumley making a change for memory purposes.
	git show -s 8ab56638497187169c631069c63f7accbd8a122d

vim:tw=72:noet:ts=8:sts=4:sw=4:ai: