- Put the name of the exercise in the subject line of the commit.
E.g.
hamming: Add test case for strands of unequal length - The subject line should be a one-sentence summary, and should not include the word and (explicitly or implied).
- Any extra detail should be provided in the body of the PR.
- Don't submit unrelated changes in the same pull request.
- If you had a bit of churn in the process of getting the change right, squash your commits. Refer to the guidelines on squashing commits.
- If you had to refactor in order to add your change, then we'd love to see two commits: First the refactoring, then the added behavior. It's fine to put this in the same pull request, unless the refactoring is huge and would make it hard to review both at the same time.
- If you are referencing another issue or pull-request, for instance closes #XXX or see #XXX, please include the reference in the body of the PR, rather than the subject line. This is simply because the subject line doesn't support markdown, and so these don't get turned into clickable links. It makes it harder to follow and to go look at the related issue or PR.
- Please also refer to the guidelines for commit messages.