Commit Messages - Eastside-Catholic/Tutorial GitHub Wiki

Click to go back to Home Page

Commit messages should accurately describe the changes made in the commit.

We should be able to find a code change based on ONLY the commit message.

If you can't come up with a concise, accurate commit message, you are probably changing too many things in one commit.

###Good Commit Messages

• Solved Issue #2
• Added AI for blue ghost
• Removed broken network code

###Bad Commit Messages

• Added ghost AIs, savegames, keyboard controls, 3D glasses, potato farms and printing; removed a bug causing crashes; added helpful comments to CupcakeCo.java; rewrote the event loop; sorted imports by length; made variable names more clear; removed unnecessary whitespace.
• Fixed things
• Changed Toaster.java
• Made it better
• ebrbrbrbrbrbrbrbrbrbrbr

If you want to learn more about what commits are, click here.