Add AI policy to contribution guide#3959
Conversation
| PR and issue. Help us out by keeping comments short and direct. PR review comments | ||
| can be marked as resolved without commenting "Done" on every one. |
There was a problem hiding this comment.
I am hesitant about the second sentence on PR review comments. We have gone back and forth about how people should resolve comments (e.g., should they wait until the reviewer says it's good?).
There was a problem hiding this comment.
I often respond to comments (manually) saying I have completed a requested change.
There was a problem hiding this comment.
But maybe I should not do that?
There was a problem hiding this comment.
Yeah, that's why I don't think I like the guidance here. Even we don't universally follow this.
There was a problem hiding this comment.
I'm fine with removing it and will make that change.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3959 +/- ##
==========================================
+ Coverage 90.11% 90.13% +0.02%
==========================================
Files 908 909 +1
Lines 108378 109274 +896
==========================================
+ Hits 97660 98492 +832
- Misses 10718 10782 +64
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: Miranda Mundt <55767766+mrmundt@users.noreply.github.com> Co-authored-by: John Siirola <jsiirola@users.noreply.github.com>
Removed redundant instruction about marking PR review comments as resolved.
| Review process: | ||
| - [ ] ALL AI-generated content was rewritten by the PR author | ||
| - [ ] ALL AI-generated content was thoroughly reviewed and verified by the PR author | ||
| - [ ] AI-generated content was contributed directly to the repository |
There was a problem hiding this comment.
Is the intent behind this line to check if "CoPilot did it for me"? If so, I wouldn't say it's entirely clear.
There was a problem hiding this comment.
I think this section is meant to help us understand the extent to which the contributor reviewed the AI-generated content but this was a change suggested by @jsiirola so I'm hoping he'll also chime in.
There was a problem hiding this comment.
The original template was a request for free-response from the author. My concern is that they won't know what we are looking for and could write anything from a novel to the equivalent of "LGTM". The idea here is for a simple template to prompt them to to directly answer our most important questions.
4 participants
Summary/Motivation:
This PR adds an AI contribution policy to our contributor guide based on discussions we've had at the Pyomo developer meetings. This is meant to be a "living" policy that will be regularly updated as the tools and our observations evolve. Feedback and comments are welcome.
Changes proposed in this PR:
Legal Acknowledgement
By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution: