Editing Getting Your Pull Accepted (section)

=== 5. Make explicit commit logs ===
Be clear in exactly what each of your commits do. Esoteric or jokey commit logs are hard for future coders to interpret which makes tracing changes harder. Don't make it too long however since an actual description of your changes goes into your pull request's comment. Ideally the first line should be a short summary, then you have a more fleshed out commentary below that.

Make sure you also add a changelog entry if you're making a big player facing change.
The guide to adding changelogs can be found in the [[Guide_to_Changelogs]]