-
-
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
Merged
+31
−0
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 <[email protected]>` or a co-author via | ||
| a `Co-authored-by: <agent-identity>` trailer. | ||
|
Byron marked this conversation as resolved.
|
||
|
|
||
| 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 | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.