3 ms·
I enjoy writing good PR messages. They border on too elaborate, with too much detail (better to err on that side though). They often aren't read. "TL;DR" is wha
by diarrhea 3y ago
I enjoy writing good PR messages. They border on too elaborate, with too much detail (better to err on that side though). They often aren't read. "TL;DR" is what I hear, without shame. Similar to how "math sucks!" in high school was popular. Reading/writing documentation? That's for nerds!
Then later on confusion and questions, all easily solved if the PR (Jira ticket, etc...) had been read properly, or at all. It's very disheartening.
- erikpukinskis 3y agoI also write pretty detailed PR messages… mostly as comments on specific lines of the PR, either in the code itself if they’re worth keeping around. Or GitHub comments if they’re only of temporary relevance. But I’m not sad at all if they’re not read. It’s there if people want/need it. If they don’t then it’s easily skipped. I’m also not mad if someone asks me a question that could’ve been answered by reading a comment… different people have different ways of learning and I am happy to show up in whatever mode they find convenient. If a specific colleague is frequently missing info that was available in comments maybe that’s a growth opportunity for them to up their pace, and I might drop something in their suggestion box, but we’re all learning.
- Paul-Craft 3y ago> "TL;DR" is what I hear, without shame. Give the people what they want, then. Why not literally put a "TL;DR" at the top, like an executive summary, or something? The important thing is that all the gory details are present for those who want and need them. For those who may not, such as people not reviewing and approving the PR, a literal TL;DR can be a godsend.