Skip to content

Commit 57fde97

Browse files
committed
Clarify AI usage in responses
1 parent aaf1af3 commit 57fde97

1 file changed

Lines changed: 15 additions & 12 deletions

File tree

‎docs/source/contributor-guide/ai-policy.md‎

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -62,25 +62,28 @@ PRs you have your agent generate and submit for you.
6262
## Responding to review comments
6363

6464
The same policy applies to review discussion as to the code itself: reviewers
65-
want to talk to **you**, not to your AI tool. Please do not paste an AI-generated
66-
response to a review comment verbatim or have your agent respond to
67-
reviewer comments. Some signs that a reply is an unreviewed AI dump:
68-
69-
- It summarizes the diff rather than answering the question that was asked.
70-
- It lists the commands that were run locally (e.g. `cargo fmt`, `cargo test`)
71-
and whether they passed. This is not useful to reviewers because CI already
72-
runs these checks.
73-
- It contains statements that don't make sense in context, such as claiming
65+
want to talk to **you**, not to your AI tool. Please do not respond to reviewer
66+
comments with unreviewed, fully AI-generated responses as again this puts all the
67+
burden on the reviewer and you learn nothing. We expect your responses to be
68+
in your own words, though it is fine to use AI to help prepare your response
69+
(for example to understand the comment, or help translate your response to
70+
English). Examples of unhelpful unreviewed AI comment dumps:
71+
72+
- Summarizes the diff rather than answering the question that was asked.
73+
- Lists the commands run locally (e.g. `cargo fmt`, `cargo test`)
74+
and whether they passed. This is not useful to reviewers because CI already runs
75+
these checks.
76+
- Contains statements that don't make sense in context, such as claiming
7477
tests could not be run because `cargo` is not installed.
7578

7679
For example, see [this review thread in arrow-rs][arrow-rs-review-example] where
7780
the reviewer asked a design question, and received several replies that
7881
described what had changed and which commands had been run, rather than an
7982
answer to the question.
8083

81-
The point of code review is to help the project **and** to help you grow as an
82-
engineer, so please read each comment, make sure you understand it, and reply
83-
in your own words.
84+
Again, the point of code review is to help the project **and** to help you grow
85+
as an engineer, so please read each comment, make sure you understand it, and
86+
reply in your own words.
8487

8588
[arrow-rs-review-example]: https://github.com/apache/arrow-rs/pull/11209#discussion_r4145512124
8689

0 commit comments

Comments
 (0)