Simplify template - #757
Conversation
nicoburns
left a comment
There was a problem hiding this comment.
Seems like an improvement (much less verbose! :)). I would recommend moving LLM Contributions to the bottom (or just above changelog).
I generally don't like the changelog section. Seems fiddly. And I generally consider changelog maintenance a maintainer activity rather than a contributor activity. I would pretty much never want to block a PR landing on changelog.
Could you expand on this? The current position is aiming to ensure that reviewers can have the context about how likely the rest of the pr is to be nonsense. I guess maybe your thinking is that the "use your own words" should hopefully cover that?
My experience with doing changelog maintenance is that there is no easy heuristic for "does this pr need a changelog" (or more so, there's no way for a PR to explicitly say "this doesn't need a changelog"). This means that it's easy for prs which really should have had changelog entries to just not. The main idea of this scheme is that people can opt into writing a changelog in a low friction way (without fighting merge conflicts). (As an aside - I wonder if there's a world where we ask the approver to write a changelog entry? One problem is that I don't see how that could be "enforced" (that is, remembered, as we probably wouldn't want to hard block on it).)
Fwiw, this whole scheme is trying to lower the amount of work that does get blocked on the changelog. I'd like to keep the experiment going for now. But I'll admit, it requires me finding more time to work on Gazeto. |
LLM Contributions: None.
Based on feedback in #parley > Parley PR template, the current template is too long.
People also seem unable to understand the syntax of using square brackets for optional arguments. I had been under the impression that this was common, but I've not observed anyone actually use it correctly. As such, I've removed it from the template.
Additionally, people using LLM tools to open their PRs is currently indistinguishable from people using e.g. IDEs or other tools which don't expose it. I'm hinting towards this template in the CHANGELOG file to at least have a chance for LLMs to follow this (I've observed LLMs having a drive to make CHANGELOG entries).
Changelog: None