Skip to content

MINOR: [Dev] Ask for generative AI disclosure in PR template - #51282

Merged
raulcd merged 3 commits into
apache:mainfrom
pitrou:minor-pr-template-ai
Sep 16, 2026
Merged

raulcd merged 3 commits into
apache:mainfrom
pitrou:minor-pr-template-ai

Conversation

@pitrou

@pitrou pitrou commented Sep 10, 2026

Copy link
Copy Markdown
Member

Rationale for this change

Often, PR submitters who evidently used AI don't disclose their usage of AI. This adds a nudge to the PR template that they should be upfront about their usage of AI.

The downside is that it's one more question to answer when submitting a PR.

Are these changes tested?

No.

Are there any user-facing changes?

No.

@pitrou

pitrou commented Sep 10, 2026

Copy link
Copy Markdown
Member Author

@kou @raulcd @rok @HuaHuaY @wgtmac @thisisnic What do you think? Is this adding too much to the PR template?

@rok

rok commented Sep 10, 2026 •

Copy link
Copy Markdown
Member

How about adding a checkbox instead? (This was partially generated, idea was mine)
Written by:

  • Human
  • Human + AI
  • AI

Reviewed by:

  • Not reviewed
  • Human
  • AI
  • Human + AI

@thisisnic

Copy link
Copy Markdown
Member

I like the checkboxes, yeah!

@wgtmac

wgtmac commented Sep 10, 2026

Copy link
Copy Markdown
Member

I would expect that sometimes even the PR description is written by AI. We can tell the submitters to respect the PR template if not properly written.

@kou kou 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.

+1

I want to keep the "AI generation guidelines" link even if we use the suggested checkbox style.

We can tell the submitters to respect the PR template if not properly written.

It's out of scope of this PR but I want to automate it like our GH-XXX PR title check.

Comment thread .github/pull_request_template.md Resolved
@pitrou
pitrou force-pushed the minor-pr-template-ai branch 2 times, most recently from 812b6e5 to b327fe6 Compare September 14, 2026 15:39
@pitrou

pitrou commented Sep 14, 2026

Copy link
Copy Markdown
Member Author

How about adding a checkbox instead? (This was partially generated, idea was mine)

I suppose you gained a lot of productivity by generating this.

Since multiple boxes can be checked in a list, I removed the superfluous "Human + AI" choices.

@pitrou

pitrou commented Sep 14, 2026

Copy link
Copy Markdown
Member Author

To all reviewers: feel free to comment on the updated version!

@rok

rok commented Sep 14, 2026

Copy link
Copy Markdown
Member

Looking at #51329 - should we expand this to issue templates?

@kou kou 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.

+1

Comment thread .github/pull_request_template.md Resolved
@pitrou
pitrou force-pushed the minor-pr-template-ai branch from b327fe6 to 98acf7e Compare September 16, 2026 06:57
@raulcd
raulcd merged commit b274238 into apache:main Sep 16, 2026
31 checks passed
@pitrou
pitrou deleted the minor-pr-template-ai branch September 16, 2026 07:20
@Reranko05

Copy link
Copy Markdown
Collaborator

One small issue with the new checkboxes: GitHub treats [ ] as task-list items, so selecting the AI disclosure options makes the PR show e.g. 2 of 5 tasks completed. Since these checkboxes are metadata rather than tasks, that progress indicator is a bit misleading. Could we use a non-task representation for these fields?

@raulcd

raulcd commented Sep 16, 2026 •

Copy link
Copy Markdown
Member

@Reranko05 where is the message (2 of 5 tasks completed) show? I can't see it on the PR page, example of my last PR that already uses checkboxes:

Maybe it's because is draft? I

@Reranko05

Reranko05 commented Sep 16, 2026 •

Copy link
Copy Markdown
Collaborator
Screenshot 2026-09-16 174426 @raulcd I am referring to the circular task-progress tracker that appears on the PR page when the checkboxes are selected.

@raulcd

raulcd commented Sep 16, 2026 •

Copy link
Copy Markdown
Member

I suppose GitHub doesn't like consistency 😃
image

@Reranko05

Copy link
Copy Markdown
Collaborator

@raulcd Ah, I got it. It's because GitHub currently has two versions of the PR list. I am using the classic view, where the circular task-progress indicator is shown, while the new PR list doesn't show it. Both views are currently available.

@Reranko05

Copy link
Copy Markdown
Collaborator

@raulcd @HuaHuaY Do we want to change the checkboxes so the template makes sense in both versions, or should we just leave it as is? If we want to change it, I've created #51356 for this. Otherwise, I will close it.

MassivePizza pushed a commit to massive-com/arrow-rs that referenced this pull request Nov 11, 2026
# Which issue does this PR close?

<!--
It is not necessary to raise an issue, but it is encouraged if it is a
non-trivial
enhancement/bug.

If this PR relates to an existing issue, but does not fully resolve it,
please change
the wording below from "Closes #NNN" to "Relates to #NNN" or "Part of
#NNN" to avoid
false closing an issue.
-->

None

# Rationale for this change

<!--
Why are you proposing this change? If this is already explained clearly
in the
issue then this section is not needed. Explaining clearly why changes
are proposed
helps reviewers understand your changes and offer better suggestions for
fixes.

Please try to explain the problem you are trying to solve in terms of
the user-visible
behavior, rather than the implementation.
-->
The contributor guide asks contributors to disclose AI usage, but the PR
template does not remind them to do so. Apache Arrow added a similar
reminder in apache/arrow#51282.

# What changes are included in this PR?

<!--
There is no need to duplicate the description in the issue here but it
is
sometimes worth providing a summary of the individual changes in this
PR.
-->
Add an AI usage disclosure section with brief guidance and a link to the
contributor guide. Contributors can remove the section if they did not
use AI tools.

# Are these changes tested?

<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code

If tests are not included in your PR, please explain why (for example,
are they
covered by existing tests, if so identify these tests)?

If this PR claims a performance improvement, please include evidence
such as
benchmark results.

DO NOT simply paste a list of commands ran to verify the code; this is
what our
CI is for and it pollutes the PR. ONLY explain if testing was included
with this
PR, or why it wasn't.
-->
No.

# Are there any significant user-facing changes?

<!--
Significant user-facing changes include:
- Breaking public API change
- Significant change to existing functionality (e.g. function returns
something different)

These need to be explicitly called out to ensure we have proper
documentation if
required and to ensure we follow proper semantic versioning.

DO NOT restate the changes of this PR; if a bug was fixed and already
explained
above, we don't need this to be restated as a user-facing change.
-->
No.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants