Skip to content

Create PULL_REQUEST_TEMPLATE.md - #23523

Open
sureshjoshi wants to merge 2 commits into
mainfrom
pr-template
Open

Create PULL_REQUEST_TEMPLATE.md#23523
sureshjoshi wants to merge 2 commits into
mainfrom
pr-template

Conversation

@sureshjoshi

Copy link
Copy Markdown
Member

Description

What problem does this change solve, why is it needed, and how did you solve it? Link any related issues.

Closes #23080 - with churn from 2021 (#11884)

Basically, just to remind PR creators that we have AI disclosures, and that all other communication is supposed to be human crafted.

Also, a lot of PRs crop up without any discussion of testing - which is concerning.

Testing

How did you verify this change? Are there any sharp edges that you're unsure about?

Used the Markdown preview and hoped for the best.

LLM Assistance Disclosure

Per the Contribution overview — LLM Assistance Notice, disclose any use of AI/LLM assistance in writing, introspecting, reading, reasoning about, debugging, or testing this change.

I used Composer 2.5 and Grok 4.5 and pointed them at our contribution guidelines. Then I deleted everything except for the "LLM Assistance Disclosure" section, because it just felt right.

Release notes

If this change needs release notes, add or update entries under docs/notes/. Otherwise, a maintainer can label the PR with release-notes:not-required.

@sureshjoshi sureshjoshi added category:documentation release-notes:not-required [CI] PR doesn't require mention in release notes labels Jul 11, 2026
@sureshjoshi

Copy link
Copy Markdown
Member Author

I mentioned this PR template on several meetings, but then kept forgetting to execute on it.


## Release notes

_If this change needs release notes, add or update entries under `docs/notes/`. Otherwise, a maintainer can label the PR with `release-notes:not-required`._

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we just link the versioned file here for current release?

If we have an AI skill in place for doing "next version" procedure, then the skill can have the instruction to advance the version.


## LLM Assistance Disclosure

_Per the [Contribution overview — LLM Assistance Notice](https://www.pantsbuild.org/stable/docs/contributions#llm-assistance-notice), disclose any use of AI/LLM assistance in writing, introspecting, reading, reasoning about, debugging, or testing this change._

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

https://tombedor.dev/human-attention-and-human-effort/

I find this post to say what I think on this subject.

@cburroughs

Copy link
Copy Markdown
Contributor

Today when one ones a PR, the description is the text of the commit. In most cases I think this is what one would want.

With a PR template, where does said text go? Above the template? Below? Thrown away? Interpolated with a variable?

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

Labels

category:documentation release-notes:not-required [CI] PR doesn't require mention in release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create a PR template

5 participants