-
-
Notifications
You must be signed in to change notification settings - Fork 977
Add AI-disclosure and quality requirements to the contribution guidelines #2143
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,37 @@ The following is a short step-by-step rundown of what one typically would do to | |
| - Feel free to add yourself to AUTHORS file. | ||
| - Create a pull request. | ||
|
|
||
| ## Quality expectations | ||
|
|
||
| Contributions must be made with care and meet the quality bar of the surrounding code. | ||
| That means a change should not leave GitPython worse than it was before: it should be | ||
| readable, maintainable, tested where practical, documented and consistent with the | ||
| existing style and behavior. | ||
|
|
||
| A contribution that works only narrowly but lowers the quality of the | ||
| codebase may be declined. The maintainers may not always be able to provide | ||
| detailed feedback. | ||
|
|
||
| ## AI-assisted contributions | ||
|
|
||
| If AI edits files for you, disclose it in the pull request description and commit | ||
| metadata. Prefer making the agent identity part of the commit, for example by using | ||
| an AI author such as `$agent $version <ai-agent@example.invalid>` or a co-author via | ||
| a `Co-authored-by: <agent-identity>` trailer. | ||
|
Comment on lines
+26
to
+28
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's very unclear to me why having the agent listed as the author and the human listed as a coauthor would be less safe than any other approach, with respect to the specific concerns raised here. With that said, the core of Copilot's point here is actually a good point: there are some advantages to the use of an |
||
|
|
||
| Agents operating through a person's GitHub account must identify themselves. For | ||
| example, comments posted by an agent should say so directly with phrases like | ||
| `AI agent on behalf of <person>: ...`. | ||
|
|
||
| Fully AI-generated comments on pull requests or issues must also be disclosed. | ||
| Undisclosed AI-generated comments may lead to the pull request or issue being closed. | ||
|
|
||
| AI-assisted proofreading or wording polish does not need disclosure, but it is still | ||
| courteous to mention it when the AI materially influenced the final text. | ||
|
|
||
| Automated or "full-auto" AI contributions without a human responsible for reviewing | ||
| and standing behind the work may be closed. | ||
|
|
||
| ## Fuzzing Test Specific Documentation | ||
|
|
||
| For details related to contributing to the fuzzing test suite and OSS-Fuzz integration, please | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.