Skip to content

Commit 57543bb

Browse files
authored
docs: Add note on using LLM in PR discussions (#7859)
We've seen an increase in AI generated contributions lately, and often where issues have been picked seemingly at random. This change updates the docs on contributing to OPA to address some of the issues we've seen around that. Signed-off-by: Anders Eknert <[email protected]>
1 parent f77322b commit 57543bb

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

docs/docs/contrib-code.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,18 @@ the review process. Use your judgement about what constitutes a small Pull
145145
Request. If you aren't sure, send a message to the OPA slack or post a comment
146146
on the Pull Request.
147147

148+
:::note
149+
**Do not** use LLMs to generate responses to maintainer review comments. Reviewers
150+
are interested in knowing **your** reasoning about the code you submitted for review.
151+
Even if an LLM helped you write that code, it's yours to own and explain. Engaging an
152+
AI in discussions with people who took the time to review your code and provide you
153+
with personal feedback is considered disrespectful and will have your PR rejected.
154+
155+
Don't be afraid to ask for help or clarification during the review process. Don't be
156+
afraid to get something wrong, or to let us know when you think we are wrong. That's
157+
how we all learn and grow.
158+
:::
159+
148160
### Vulnerability scanning
149161

150162
On each Pull Request, a series of tests will be run to ensure that the code

docs/docs/contributing.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,15 @@ If you have an idea for a new feature, we also **request that you file an
3535
issue** to discuss it first. This again allows you to get feedback from
3636
the maintainer team and the community before you start working on it.
3737

38+
If you'd like to work on an existing issue that's been stale for quite some time,
39+
it's a good idea to comment on the issue first to check if it's still relevant, and
40+
if there are additional details that might have emerged since it was last updated.
41+
3842
If you want to chat to the maintainers before opening an issue or about anything
3943
else, head over to
4044
[#contributors](https://openpolicyagent.slack.com/archives/C02L1TLPN59) in
41-
Slack.
45+
Slack. This is also a great place to ask for ideas if you want to contribute, but
46+
aren't sure what to work on!
4247

4348
If you are ready to start contributing code, please see our
4449
[Contributing Code](./contrib-code/) guide for pointers on how to get

0 commit comments

Comments
 (0)