Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .asf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ github:

copilot_code_review:
enabled: true
review_drafts: true
review_drafts: false
review_on_push: true

notifications:
Expand Down
21 changes: 21 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Instructions

## Code review

You are a pragmatic senior developer. When reviewing pull requests,
follow these rules to avoid noise and redundancy:

- Be concise: Keep comments brief and to the point. Avoid
conversational filler or praising the code unless it's exceptional.
- High-impact only: Focus on logic errors, security vulnerabilities,
performance bottlenecks, and breaking changes.
- Skip the Obvious: Do not describe what the code is doing. Assume the
reader understands the code.
- Ignore trivialities: Do not comment on minor style issues or things
that an automated linter should catch.
- Single comment per issue: If the same pattern occurs multiple times,
mention it once and suggest a global fix instead of commenting on
every line.
- First-time contributors: For users new to this repository,
explicitly instruct them to "Please check and address all review
comments in this PR."
1 change: 1 addition & 0 deletions dev/release/rat_exclude_files.txt
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,5 @@ r/tools/nixlibs-allowlist.txt
.gitattributes
ruby/red-arrow/.yardopts
ruby/red-arrow-format/lib/arrow-format/org/*
.github/copilot-instructions.md
.github/pull_request_template.md
4 changes: 4 additions & 0 deletions docs/source/developers/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,10 @@ When contributing a patch, use this list as a checklist of Apache Arrow workflow
merged, this will be retained in the extended commit message.
* Make sure that your code **passes the unit tests**. You can find instructions how
to run the unit tests for each Arrow component in its respective README file.
* In order to improve our code and your review experience, we have
enabled GitHub Copilot reviews to automate the first pass. Please
address all GitHub Copilot comments by either implementing them, or
explicitly responding and explaining why you chose not to.

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.

Asking people to respond to Copilot comments is one more hurdle for contributors. Why is this important?

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'm not sure whether this is one more hurdle or not. Contributors need to respond to comments from human reviewers. Are they different?

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 think Arrow core developers are less likely to hallucinate than an LLM.

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.

We can start with something a little more relaxed:

Reviewers and contributors are encouraged to address valid suggestions; you don't need to respond to every comment, but please don't ignore them either.

And if we see that general Copilot comments are good (not that many hallucinations or repeated comments) we can revisit the phrasing.

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.

Thanks.

I've applied your suggestion.

Can we merge and try this configuration now?


Core developers and others with a stake in the part of the project your change
affects will review, request changes, and hopefully indicate their approval
Expand Down
Loading