Repository navigation
Add AI policy to contributors guide and update PR template - #4467
nickbianco wants to merge 1 commit into
Conversation
|
@tkuchida @carmichaelong @aymanhab @adamkewley Happy to hear any thoughts or suggestions on this! |
adamkewley
left a comment
There was a problem hiding this comment.
@adamkewley reviewed 2 files and all commit messages, and made 1 comment.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on nickbianco).
aymanhab
left a comment
There was a problem hiding this comment.
@aymanhab reviewed all commit messages and made 1 comment.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on carmichaelong and tkuchida).
tkuchida
left a comment
There was a problem hiding this comment.
Looks good. I had a few (human-generated) suggestions, but this is mostly forward looking so I expect it will evolve regardless.
| ### Looking for feedback on... | ||
|
|
||
| ### AI/LLM usage | ||
| <!-- Please disclose any AI or LLM tools used to create this pull request.--> |
There was a problem hiding this comment.
Suggest "Please disclose any AI or LLM tools that were used to create this pull request, how they were used, and what quality checks were done" (or similar) since the reviewer will want to know more than what the tools were. Also, nit: there's a space before "P" but not after "."
|
|
||
| ### Looking for feedback on... | ||
|
|
||
| ### AI/LLM usage |
| Contributors to OpenSim are welcome to use Artificial Intelligence (AI) or Large Language Model (LLM) coding tools to create pull requests. However, all pull requests must be created with a human in the loop. The contributor is always the author and is fully accountable for their contributions. Contributors should be confident that their submission is high quality and worth the (limited) time of the maintainers. | ||
|
|
||
| - You must disclose in the pull request description that you used an AI/LLM tool or model and how it was used. | ||
| - You must review all AI/LLM-generated code, comments, or documentation before requesting a review. |
| - You must disclose in the pull request description that you used an AI/LLM tool or model and how it was used. | ||
| - You must review all AI/LLM-generated code, comments, or documentation before requesting a review. | ||
| - You must not attribute an AI/LLM model authorship to any commit in a pull request (e.g., "Co-Authored by Claude"). | ||
| - You must answer all maintainer questions and pull request review comments yourself, without using an LLM or AI chatbot. |
There was a problem hiding this comment.
(This rule is unenforceable. Typically—except for things like the suspicious use of em dashes—AI is undetectable. Practically, this might just mean that someone will adjust the prompt so that the AI-generated response sounds less technical 🤷. The rule can be left here if that's the objective.)
|
|
||
| AI/LLM Usage Policy | ||
| ------------------- | ||
| Contributors to OpenSim are welcome to use Artificial Intelligence (AI) or Large Language Model (LLM) coding tools to create pull requests. However, all pull requests must be created with a human in the loop. The contributor is always the author and is fully accountable for their contributions. Contributors should be confident that their submission is high quality and worth the (limited) time of the maintainers. |
Fixes issue #4420
Brief summary of changes
Updates
CONTRIBUTING.mdto include a new section "AI/LLM Usage Policy" which lays out guidelines for using AI or LLM coding assistance tools when creating pull requests. Inspired by the AI contributing guides from Homebrew and LLVM.Also updates the pull request template to encourage contributors to disclose any AI/LLM usage.
Testing I've completed
Looking for feedback on...
CHANGELOG.md (choose one)
This change is