Committing

A commit should be for the smallest set of changes possible. This ensures that changes are self contained and not polluted by changes to something unrelated. If you have many changes to make, create a local branch, commit individual changes to that, then merge it into the main repo.

When committing changes use the following method for your comments:

Did the thing (issue #x)

had to change something to something because reasons

turned the dodah into a whatsit

The first line of your commit comment should be exceptionally brief (looking for < 50 characters if possible). The line should start with the name of the component you have altered, with a very brief note of what you changed. The line should have the issue number on the end of it. Adding the issue number to the checkin comment will cause the note to appear in the history of the issue. If you feel that the note needs some clarification / extra information as to what you changed add that on following lines.

If a check in happens and the notes do not have the details for the changes, either add them through github or add them to the issue.