A month ago you told a colleague their pull request descriptions were too short, and that reviewers struggled to understand the changes. They took it seriously. Now every description is a page long, with background, alternatives and a list of risks. Reviews have become slower, not faster, and someone in the team has started joking about it.
It is uncomfortable to realise your feedback helped cause this. It is also very common. Feedback is a guess about what will help, and you gave it from your side of the problem, without being sure what they would do with it.
First, do not blame them. They did what you asked, as well as they understood it. If you suggest they went too far, you are telling them that listening to you was the mistake. That makes them less likely to listen to anyone next time.
Instead, take your share openly. I think my comment last month pushed you further than I meant. The longer descriptions are really thorough, and some of that is great. But I think I asked for the wrong thing.
Then be more specific than you were the first time. Most of the original problem was probably narrower than your words. Perhaps what reviewers needed was two things. What the change does, and why, in a few lines at the top. Then anything unusual they should look at carefully. Everything else can go in the ticket or a linked document. Show an example if you can, so they can see the length you have in mind.
Ask what they found useful about writing the longer versions. Sometimes there is something good in it you would lose by simply asking them to stop. Maybe writing the risks down helped them catch a bug before review.
Notice the team joke too. If it continues, ask people to stop. Your colleague changed their habits because they were given feedback, and they deserve better than being laughed at for it.
And learn the lesson for yourself. When you give feedback, follow up after a week or two and ask how it is going. A short check early is much easier than a correction later. Good feedback is not one conversation. It is the first step in a few small ones.
– Asael Shinder
Top comments (0)