-
Notifications
You must be signed in to change notification settings - Fork 51
policies: Add AI Policy. #176
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
Open
jcolp
wants to merge
1
commit into
asterisk:main
Choose a base branch
from
jcolp:ai-policy
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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
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 |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # AI Policy | ||
|
|
||
| We recognise that AI coding assistants are now a regular part of many developers' workflows and can improve productivity. Thoughtful use of these tools can be beneficial, but AI-generated PRs can sometimes lead to | ||
| undesirable additional maintainer burden. For this reason, PRs that appear to be fully generated by AI with little to no engagement from the author may be closed without further review. | ||
|
|
||
| Human-generated mistakes tend to be easier to spot and reason about, and code review is intended to be a collaborative learning experience that benefits both submitter and reviewer. When a PR appears to have been | ||
| generated without much engagement from the submitter, reviewers with access to AI tools could more efficiently generate the code directly, and since the submitter is not likely to learn from the review process, their time is | ||
| more productively spent researching and reporting on the issue. | ||
|
|
||
| We are not opposed to the use of AI tools in generating PRs, but require the following: | ||
|
|
||
| * Only submit a PR if you are able to debug and own the changes yourself - review all generated code to understand every detail. [Apache Datafusion has a useful explanation of **why fully AI-generated PRs without understanding are not helpful**](https://datafusion.apache.org/contributor-guide/index.html#why-fully-ai-generated-prs-without-understanding-are-not-helpful). | ||
| * Comply with the coding guidelines including style, conventions, and commit messages | ||
| * Be upfront about AI usage and summarise what was AI-generated | ||
jcolp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * If there are parts you don't fully understand, leave comments on your own PR explaining what steps you took to verify correctness | ||
| * Watch for AI's tendency to generate overly verbose output (comments and code), unnecessary test cases, and incorrect fixes - if you can not explain a fix then it will not be accepted | ||
| * Break down large PRs into smaller ones to make review easier | ||
| * Ensure that your PR has not already been solved | ||
|
|
||
| If these conditions are not met the project may close the PR without further review. | ||
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
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.