Skip to content

GH-55259: [Docs] Add guidelines for reviewers on AI generated PRs - #55260

Open
raulcd wants to merge 4 commits into
apache:mainfrom
raulcd:GH-55259
Open

raulcd wants to merge 4 commits into
apache:mainfrom
raulcd:GH-55259

Conversation

@raulcd

@raulcd raulcd commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

Rationale for this change

Add documentation of our practices for AI generated code/review comments.

What changes are included in this PR?

Some documentation with a proposed message and indications about possibility of closing PRs or adding labels indicating this might be AI-slop or requires a human in the loop.

Are these changes tested?

No only docs.

Are there any user-facing changes?

No

Was AI used for this PR?

In accordance to the AI generation guidelines, please disclose below whether and how AI was used in this PR.

PR code and description written by:

  • Human
  • AI

Reviewed before submission by:

  • Human
  • AI
  • Not reviewed

@raulcd

raulcd commented Oct 26, 2026

Copy link
Copy Markdown
Member Author

@github-actions crossbow submit preview-docs

@github-actions github-actions Bot added the awaiting committer review Awaiting committer review label Oct 26, 2026
@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #55259 has been automatically assigned in GitHub to PR creator.

@github-actions

This comment was marked as outdated.

@raulcd

raulcd commented Oct 26, 2026

Copy link
Copy Markdown
Member Author

@github-actions crossbow submit preview-docs

@github-actions

This comment was marked as outdated.

@raulcd
raulcd marked this pull request as ready for review October 26, 2026 12:26
Copilot AI balanced review requested due to automatic review settings October 26, 2026 12:26
@raulcd

raulcd commented Oct 26, 2026

Copy link
Copy Markdown
Member Author

Copilot AI left a comment

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.

🟢 Approval recommended

The documentation changes address the requested reviewer guidance with no unresolved blocking issues.

No open issues 🎉

What changed in this PR

This documentation-only PR extends Arrow’s AI contribution guidelines with expectations for human participation during review, addressing #55259.

Changes:

  • Clarifies that contributors should engage directly with reviewers.
  • Documents possible closure or labeling of PRs showing excessive reliance on AI.
  • Adds an example reviewer message linking to the AI-generated code policy.
File Description
docs/​source/​developers/​overview.rst Adds human-engagement expectations and guidance for responding to excessive AI usage.

Review effort: Balanced

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

Thanks! Just one nit connected to the dropdown box.

Comment thread docs/source/developers/overview.rst Outdated
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings October 26, 2026 14:06

Copilot AI left a comment

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.

🟢 Approval recommended

The focused documentation changes match the stated purpose and have no identified blocking issues.

No open issues 🎉

Review effort: Balanced

@raulcd

raulcd commented Oct 26, 2026

Copy link
Copy Markdown
Member Author

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 30347ce

Submitted crossbow builds: ursacomputing/crossbow @ actions-be29f0bb4a

Task Status
preview-docs GitHub Actions

@pitrou

pitrou commented Oct 26, 2026

Copy link
Copy Markdown
Member

I'm not sure the added paragraph adds a lot of value. All that is being said there is already said above in one form or the other.

For example:

If a reviewer finds that a contributor seems to rely excessively on AI tools instead of engaging with the review, the PR might be closed and/or tagged with a label indicating excessive AI usage.

was already expressed in:

PRs that appear to be fully generated by AI with little to no engagement from the author may be closed without further review.

@pitrou

pitrou commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

IOW, you might want to reword the existing test instead of adding more. Adding more text is not useful in itself.

and reviewers are not expected to be talking to contributors' agents but to
contributors themselves. If a reviewer finds that a contributor seems to rely
excessively on AI tools instead of engaging with the review, the PR might be
closed and/or tagged with a label indicating excessive AI usage.

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 appreciate we have a need for filtering out low-effort PRs, but I worry such a tag would create unnecessary drama, and think we might have an easier life by creating a positive tag and recommending reviewers filter on that if they want a low chance of AI PRs

For what could qualify someone for a positive tag, I quite like the prioritisation order listed at the bottom of this blog post by Andrew Lamb: https://andrew.nerdnetworks.org/blog/2026/10/19/my-plan-for-reviewing-prs-in-open-source-projects-in-the-age-of-ai/

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.

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.

Sure, but that's something else entirely, just by the same person.

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.

FWIW I'm opposed to that as well as it's labelling the individual not the action. It's going to feel very personal to anyone who gets a false positive.

We could achieve the same thing by just closing those PRs with an explanatory message, if we wanted to limit PRs from people who have made lots of PRs to lots of repos.

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.

(for clarity my original comment was referring only to "tagged with a label indicating excessive AI usage" and not the rest of the change)

@github-actions github-actions Bot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Oct 26, 2026
Comment on lines +202 to +209
.. dropdown:: Example of message for a PR with excessive AI usage
:animate: fade-in-slide-down
:class-container: sd-shadow-none

This PR doesn't appear to comply with our policy on tool-generated content.
Please see our AI generated code policy on AI-generated code:
https://arrow.apache.org/docs/developers/overview.html#ai-generated-code

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 like that we are providing an example for folks to use. I wonder if we want a reviewer's guide to put this into perhaps?

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.

6 participants