Skip to content

Commit 4fce185

Browse files
kouraulcdalamb
authored
GH-50115: [Dev] Adjust GitHub Copilot configuration for preliminary reviews (#50117)
### Rationale for this change We tried auto GitHub Copilot reviews recently and discussed our experience for them: https://lists.apache.org/thread/thq0dz19shxbrjypb81q5ltx8h0w54ob We want to tune auto GitHub Copilot reviews: * We don't need auto GitHub Copilot reviews for draft PR: https://lists.apache.org/thread/y7yc4yg9n4mdqd1y00w7s498y8m6yold * GitHub Copilot review is too verbose: #50023 (comment) * We need to document the expectation for contributors responding to GitHub Copilot reviews: https://lists.apache.org/thread/wvhdqqtq2ndxxjnqwnj39xfcys21tpc4 ### What changes are included in this PR? * Disable auto GitHub Copilot reviews for draft PR * Add code review instructions for GitHub Copilot * Base text is generated by Gemini 3 Flash Preview and I adjusted it ### Are these changes tested? No. We need to merge this to test this. ### Are there any user-facing changes? No. * GitHub Issue: #50115 Lead-authored-by: Sutou Kouhei <kou@clear-code.com> Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com> Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
1 parent 316d4ef commit 4fce185

4 files changed

Lines changed: 28 additions & 1 deletion

File tree

.asf.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ github:
4141

4242
copilot_code_review:
4343
enabled: true
44-
review_drafts: true
44+
review_drafts: false
4545
review_on_push: true
4646

4747
notifications:

.github/copilot-instructions.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Instructions
2+
3+
## Code review
4+
5+
You are a pragmatic senior developer. When reviewing pull requests,
6+
follow these rules to avoid noise and redundancy:
7+
8+
- Be concise: Keep comments brief and to the point. Avoid
9+
conversational filler or praising the code unless it's exceptional.
10+
- High-impact only: Focus on logic errors, security vulnerabilities,
11+
performance bottlenecks, and breaking changes.
12+
- Skip the Obvious: Do not describe what the code is doing. Assume the
13+
reader understands the code.
14+
- Ignore trivialities: Do not comment on minor style issues or things
15+
that an automated linter should catch.
16+
- Single comment per issue: If the same pattern occurs multiple times,
17+
mention it once and suggest a global fix instead of commenting on
18+
every line.
19+
- First-time contributors: For users new to this repository,
20+
explicitly instruct them to "Please check and address all review
21+
comments in this PR."

dev/release/rat_exclude_files.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,4 +101,5 @@ r/tools/nixlibs-allowlist.txt
101101
.gitattributes
102102
ruby/red-arrow/.yardopts
103103
ruby/red-arrow-format/lib/arrow-format/org/*
104+
.github/copilot-instructions.md
104105
.github/pull_request_template.md

docs/source/developers/overview.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,11 @@ When contributing a patch, use this list as a checklist of Apache Arrow workflow
104104
merged, this will be retained in the extended commit message.
105105
* Make sure that your code **passes the unit tests**. You can find instructions how
106106
to run the unit tests for each Arrow component in its respective README file.
107+
* In order to improve our code and your review experience, we have
108+
enabled GitHub Copilot reviews to automate the first pass. Reviewers
109+
and contributors are encouraged to address valid suggestions; you
110+
don't need to respond to every comment, but please don't ignore them
111+
either.
107112

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

0 commit comments

Comments
 (0)