Update AI usage policy and review guidelines#5227
Update AI usage policy and review guidelines#5227BradyAJohnston wants to merge 2 commits intodevelopfrom
Conversation
More description in the overview, detailing how we might close PRs if an interaction 'feels' like it is not productive from lack of understanding (whether due to AI usage or not).
| AI tools may be used in limited cases, for example when it is used for small amounts of AI-assisted code (e.g. autocompletion using copilot, cursor, etc...) | ||
| or for language translation purposes. **Such uses must always be declared.** | ||
|
|
||
| Please understand the reviewing capacity is very limited for the project, so large PRs which appear to not have the requisite understanding might not get reviewed, and eventually closed or redirected. |
There was a problem hiding this comment.
Bike shedding a bit, I think this might be general enough to include in the previous section after line 13.
There was a problem hiding this comment.
Sure, we can move it to the preamble.
|
|
||
| Please understand the reviewing capacity is very limited for the project, so large PRs which appear to not have the requisite understanding might not get reviewed, and eventually closed or redirected. | ||
| Understanding from authors about what code they are contributing and how it fits into the larger picture is crucial. | ||
| If reviewers feel there is a lack of understanding from looking at the code, PR descriptions or just general interactions with a contributor, we reserve the right to close the PR to save time and resources. |
There was a problem hiding this comment.
Do you want a "even if you say you aren't using AI" bit here? Would it help us?
There was a problem hiding this comment.
I wouldn't include AI-qualifiers. The more we can use general principles, the better.
|
BTW, sometimes just asking more details about the PR and its motivation is enough ;): metatensor/metatrain#1036 |
Co-authored-by: Rocco Meli <r.meli@bluemail.ch>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #5227 +/- ##
===========================================
- Coverage 93.83% 93.83% -0.01%
===========================================
Files 180 180
Lines 22475 22475
Branches 3190 3190
===========================================
- Hits 21090 21089 -1
Misses 923 923
- Partials 462 463 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
IAlibay
left a comment
IAlibay
left a comment
There was a problem hiding this comment.
I think anything I have it nit-picking, so happy to approve.
4 participants
More description in the overview, detailing how we might close PRs if an interaction 'feels' like it is not productive from lack of understanding (whether due to AI usage or not). This was discussed in the AI policy meeting.
LLM / AI generated code disclosure
LLMs or other AI-powered tools (beyond simple IDE use cases) were used in this contribution:\ no
PR Checklist
Issue raised/referenced?Tests updated/added?Documentation updated/added?package/CHANGELOGfile updated?package/AUTHORS? (If it is not, add it!)Developers Certificate of Origin
I certify that I can submit this code contribution as described in the Developer Certificate of Origin, under the MDAnalysis LICENSE.
📚 Documentation preview 📚: https://mdanalysis--5227.org.readthedocs.build/en/5227/