This absolutely has been my more recent frustration as well, specifically this:
> uniformly-formatted LLM-generated descriptions which don't do what a PR description should do, with a half-arsed LLM attempt at summary of the code changes and links to the files in the PR description. It would have been nice if you had told me what your PR is for and what your intent as the author is, and maybe to call out things which were relevant to the implementation I might have "why?" questions about.
If I want to see what the code changes do, I will read the code. I want your PR description to tell me things like:
- What the tradeoffs, if any, to this implementation are
- If there were potential other approaches you decided not to follow for XYZ reason so that I don't make a comment asking about it
- If there is more work to be done, and if so what it is
- Any impacts this change might have on other systems
- etc.
Sure, if you want to add a handful of sentences summarizing the change at a high level just to get me in context, that's fine, but again if I want to see what changed, I will go look at what changed.
> uniformly-formatted LLM-generated descriptions which don't do what a PR description should do, with a half-arsed LLM attempt at summary of the code changes and links to the files in the PR description. It would have been nice if you had told me what your PR is for and what your intent as the author is, and maybe to call out things which were relevant to the implementation I might have "why?" questions about.
If I want to see what the code changes do, I will read the code. I want your PR description to tell me things like:
- What the tradeoffs, if any, to this implementation are
- If there were potential other approaches you decided not to follow for XYZ reason so that I don't make a comment asking about it
- If there is more work to be done, and if so what it is
- Any impacts this change might have on other systems
- etc.
Sure, if you want to add a handful of sentences summarizing the change at a high level just to get me in context, that's fine, but again if I want to see what changed, I will go look at what changed.