Pull Request Commit Comments

[jonnyarnold]

Samuel will check comments on PR commit comments, as well as PR comments.

Thank you Github for making both of these comment lists of a similar format.

[reevoo-samuel]

_If you're new, read the guidelines._

Good code is tested, designed for change, easy to understand and able to cope when things go wrong.

Good pull requests are descriptive, small and short-lived.

For the Author

• [x] Description explains what you have done and why.
• [x] Tests have been written (or you have explained why you don't need tests).
• [ ] Documentation/comments have been added/updated.

For the Reviewer

• [ ] The code is well-designed and able to cope with change.
• [ ] The code is easy to understand.
• [ ] Tests cover happy and unhappy paths in the code.
• [ ] Tests are green on CI (or pulled/tested on your machine).

[errm]

broadly looks good to me bwtfdik