Skip to content

Update PR template to mention coding assistant attribution#9451

Open
mbien wants to merge 1 commit into
apache:masterfrom
mbien:robots-txt
Open

Update PR template to mention coding assistant attribution#9451
mbien wants to merge 1 commit into
apache:masterfrom
mbien:robots-txt

Conversation

@mbien

@mbien mbien commented Jun 19, 2026

Copy link
Copy Markdown
Member

minimal LLM guidelines for contributors

  • LLM/coding assistant attribution in commits and PR description via 'Assisted-by' tag
  • updated paperwork check

see https://lists.apache.org/thread/qhr3mfxg5wsv89d80nxzdd63ldjth07p


^Add meaningful description above

Click to collapse/expand PR instructions

By opening a pull request you confirm that, unless explicitly stated otherwise, the changes -

  • are all your own work, and you have the right to contribute them.
  • are contributed solely under the terms and conditions of the Apache License 2.0 (see section 5 of the license for more information).

LLMs, Commit messages and PR description:

  • Please make sure (eg. git log) that all commits have a valid name and email address for you in the Author field.
  • LLM assisted commits should be attributed with a Assisted-by: MODEL_NAME MODEL_VERSION line appended to the commit message.
    • Please mention coding assistance in the PR description too (eg. by adding the same Assisted-by line from above)
    • Please describe the changes in your own words - we'd like to know you understand the changes being made!

If you're a first time contributor, see the Contributing guidelines for more information.

If you're a committer, please label the PR before pressing "Create pull request" so that the right test jobs can run.

PR approval and merge checklist:

  1. Was this PR correctly labeled, did the right tests run? When did they run?
  2. Is this PR squashed?
  3. Are author name / email address correct? Are co-authors correctly listed? Do the commit messages need updates?
  4. Does the PR title and description still fit after the Nth iteration? Is the description sufficient to appear in the release notes?

If this PR targets the delivery branch: don't merge. (full wiki article)

@mbien mbien added this to the NB31 milestone Jun 19, 2026
@mbien mbien added doc Documentation related PRs ci:no-build [ci] disable CI pipeline labels Jun 19, 2026

@neilcsmith-net neilcsmith-net left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good, thanks! Hadn't taken in you planned to change the checker too, but makes sense.

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
- Please make sure (eg. `git log`) that all commits have a valid name and email address for you in the Author field.
- LLM assisted commits should be attributed with a `Assisted-by: MODEL_NAME MODEL_VERSION` line appended to the commit message.
- Please mention coding assistance in the PR description too (eg. by adding the same `Assisted-by` line from above)
- Please describe the changes in your own words focusing on the important aspects

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I still think this should emphasise the human side, that contributions without understanding are not helpful - eg. "Please describe the changes in your own words - we'd like to know you understand the changes being made!"

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.

I agree with that. At the very least the PR description should be human-written, for proving understanding of the changes, and to provide some signal to reviewers about the author's commitment to see the PR through.

Neil's wording would work, I think. (Including the exclamation mark.)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

what if we add another point in the sense of:

 - Contributors are expected to review and understand the submitted code, verify that the change is correct, necessary, and consistent with project standards

If a contributor can not explain a change the contribution may be rejected.

but we would have to change the title of the section a bit since this goes beyond PR text.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

something for the first list maybe? L11-14

@mbien mbien Jun 19, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I added the updated template to this PR description to be able to see the changes easier.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd rather keep it shorter and friendlier. This is also, after all, primarily text for humans to read. I know I can be guilty of being too verbose sometimes 😄 But the less there is to read the more likely it is people will take in what they need.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I have the tendency to like reading/stating requirements. I can see that this sounds friendlier. updated

@ebarboni

Copy link
Copy Markdown
Contributor

LGTM too

@mbien

mbien commented Jun 19, 2026

Copy link
Copy Markdown
Member Author

there is also the problem that CLI created PRs completely ignore the template and won't see any of this. But lets start somewhere. One step at a time.

 - LLM/coding assistant attribution in commits and PR description via
   'Assisted-by' tag
 - updated paperwork check
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:no-build [ci] disable CI pipeline doc Documentation related PRs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants