Skip to content

Simplify template - #757

Open
DJMcNab wants to merge 2 commits into
linebender:mainfrom
DJMcNab:simplify-template
Open

Simplify template#757
DJMcNab wants to merge 2 commits into
linebender:mainfrom
DJMcNab:simplify-template

Conversation

@DJMcNab

@DJMcNab DJMcNab commented Aug 26, 2026

Copy link
Copy Markdown
Member

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

@nicoburns nicoburns left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@DJMcNab

DJMcNab commented Aug 26, 2026

Copy link
Copy Markdown
Member Author

I would recommend moving LLM Contributions to the bottom (or just above 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?
It might be that this field is just a "how respectful of our time will you be" filter, and so prs which ignore it can slide down the queue. And as such, we can have it further down anyway?

I generally consider changelog maintenance a maintainer activity rather than a contributor activity.

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).
I also don't trust LLMs to write changelog entries due to their lacking theory of mind.

(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).)

I would pretty much never want to block a PR landing on changelog.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants