3 ms·

A sampling of PRs looks pretty good code-wise, but the commit messages/descriptions don't. They just summarize the changes done (something that can be gleaned

A sampling of PRs looks pretty good code-wise, but the commit messages/descriptions don't. They just summarize the changes done (something that can be gleaned from the diff) but don't give context or rationale around why the changes were necessary.

hunterbrooks 2y ago
It's most helpful when a GitHub/Linear issue is linked because the "why" is extracted, and also for larger PR's
- mhluongo 2y ago
  The "why" should be in the commit message. That's what it's for
  - cornel_io 2y ago
    Different strokes: I prefer it in the PR, with a lot of detail, with commits that are very granular and just explain what they do. PR descriptions should have all the why, test cases, pictures, etc.