Skip to content

Commit 1dadfa0

Browse files
authored
📝 Add contribution instructions about LLM generated code and comments and automated tools for PRs (#1489)
1 parent 77040d7 commit 1dadfa0

File tree

2 files changed

+45
-1
lines changed

2 files changed

+45
-1
lines changed

‎.github/workflows/issue-manager.yml‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,15 @@ jobs:
4141
"message": "As this PR has been waiting for the original user for a while but seems to be inactive, it's now going to be closed. But if there's anyone interested, feel free to create a new PR.",
4242
"reminder": {
4343
"before": "P3D",
44-
"message": "Heads-up: this will be closed in 3 days unless there’s new activity."
44+
"message": "Heads-up: this will be closed in 3 days unless there's new activity."
4545
}
46+
},
47+
"invalid": {
48+
"delay": 0,
49+
"message": "This was marked as invalid and will be closed now. If this is an error, please provide additional details."
50+
},
51+
"maybe-ai": {
52+
"delay": 0,
53+
"message": "This was marked as potentially AI generated and will be closed now. If this is an error, please provide additional details, make sure to read the docs about contributing and AI."
4654
}
4755
}

‎docs/contributing.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,3 +299,39 @@ This helps to make sure that:
299299
* The documentation is up-to-date.
300300
* The documentation examples can be run as is.
301301
* Most of the features are covered by the documentation, ensured by test coverage.
302+
303+
## Automated Code and AI
304+
305+
You are encouraged to use all the tools you want to do your work and contribute as efficiently as possible, this includes AI (LLM) tools, etc. Nevertheless, contributions should have meaningful human intervention, judgement, context, etc.
306+
307+
If the **human effort** put in a PR, e.g. writing LLM prompts, is **less** than the **effort we would need to put** to **review it**, please **don't** submit the PR.
308+
309+
Think of it this way: we can already write LLM prompts or run automated tools ourselves, and that would be faster than reviewing external PRs.
310+
311+
### Closing Automated and AI PRs
312+
313+
If we see PRs that seem AI generated or automated in similar ways, we'll flag them and close them.
314+
315+
The same applies to comments and descriptions, please don't copy paste the content generated by an LLM.
316+
317+
### Human Effort Denial of Service
318+
319+
Using automated tools and AI to submit PRs or comments that we have to carefully review and handle would be the equivalent of a <a href="https://en.wikipedia.org/wiki/Denial-of-service_attack" class="external-link" target="_blank">Denial-of-service attack</a> on our human effort.
320+
321+
It would be very little effort from the person submitting the PR (an LLM prompt) that generates a large amount of effort on our side (carefully reviewing code).
322+
323+
Please don't do that.
324+
325+
We'll need to block accounts that spam us with repeated automated PRs or comments.
326+
327+
### Use Tools Wisely
328+
329+
As Uncle Ben said:
330+
331+
<blockquote>
332+
With great <strike>power</strike> <strong>tools</strong> comes great responsibility.
333+
</blockquote>
334+
335+
Avoid inadvertently doing harm.
336+
337+
You have amazing tools at hand, use them wisely to help effectively.

0 commit comments

Comments
 (0)