3 ms·
> communicate the effect of the change as quickly as possible This should happen in the title of the PR overall. In larger projects, a single commit is rarely
by hyperbrainer 2y ago
> communicate the effect of the change as quickly as possible
This should happen in the title of the PR overall. In larger projects, a single commit is rarely pushed alone. Personally, I use it as a checkpoint to save progress rather than really it being a meaningful piece of work. But then again, I rarely work on projects with lots of people, so this may not be wholly perfect for that use case.
- mtlynch 2y ago>In larger projects, a single commit is rarely pushed alone. When I say a commit message, I mean the thing that ends up in the source history when the change is merged. So if you're doing squash and merge, then the commit message that matters is the PR title + description. For teams that just merge everything including commits like "wip" and "address notes from code review", their commit history is a mess anyway, so they have bigger fish to fry.
- hyperbrainer 2y agoI still think that your argument of "conveying most important information first" is really something that should be tackled through the title, but I agree with the rest.
- mtlynch 2y agoOh, I agree that the most important information should go in the title. Did I give the impression that it shouldn't?
- hyperbrainer 2y agoPerhaps not. On closer inspection, the inverted pyramid reference does seem to support the claim anyways. Sorry! I really need to read better.