Write good git commit messages
Good commit message summaries are important (the short one-line overview).<p>Including links to the issues the commit relates to in the body is important.<p>That said, most of what I&#x27;ve seen in large commit message bodies (like the ones I used to write) really belongs in the patch itself, as changes to the project&#x27;s formal documentation or source code comments.<p>If you thought it was worth explaining why you made the change as you did, it likely means the choice was not obvious.<p>If it wasn&#x27;t obvious, the explanation belongs in the project proper, where anyone who cares can see it, not tucked away in a commit message that may be hard to discover four or five years down the road.<p>If it&#x27;s a decision that impacts UI, the justification belongs in the project specs or docs, where people besides devs can find it (I like to keep my specs and docs as plaintext in the repo and render them to HTML for non-devs to reference).<p>If it&#x27;s a strictly internal decision, like what algorithm you chose for a function&#x27;s internals, you should explain why right there instead of hiding valuable knowledge in the commit message.