Skip to content

Commit Guidelines

Code Apprentice edited this page Jun 10, 2015 · 2 revisions
  1. Each commit should consist of a small, logical set of changes without any compiler errors. Check out the existing commit history for some examples.

  2. Each commit should have a meaningful message which describes the set of changes. At the very least, each commit should have a single line starting with "Issue #" followed by the GitHub issue number. The rest of the line should be a short summary of the issue with a maximum of 50 characters. Optionally, you may follow this header with a blank line and a lengthier explanation. This message body should have hard line endings to wrap contents on 72 columns. However, if you find yourself often needing such a lengthy description, it would probably be better to split the commit into several smaller commits. (See A Note About Git Commit Messages for an in-depth discussion about commit messages.)

  3. A single change should appear in a single commit. This means that the same textual change should not appear in multiple commits in the repository.

Supplemental Material: