-
-
Notifications
You must be signed in to change notification settings - Fork 415
[docs] add a policy for AI assisted contributions #4138
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
odow
wants to merge
11
commits into
master
Choose a base branch
from
od/ai-policy
base: master
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.
+121
−17
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
e174762
[docs] add a policy for AI assisted contributions
odow ba1f519
Update
odow c4e6d20
Move new users part to the contributing guide
odow b1f6fc2
Update
odow a493b86
Update
odow 1e6791d
Update
odow 60e1817
Update
odow 65ecc0b
Update
odow 47c7a33
Update
odow ac0f5d7
Update
odow 55a879b
Apply suggestion from @odow
odow 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,74 @@ | ||
| # AI Policy | ||
|
|
||
| This document describes how the JuMP developers will manage and respond to | ||
| AI-assisted contributions to the JuMP ecosystem. | ||
|
|
||
| "AI" herein refers to generative AI tools like large language models that can | ||
| generate, edit, and review software code; create and manipulate images; or | ||
| generate human-like communication. | ||
|
|
||
| The intent of the policy is to balance the benefits of AI-assisted contributions | ||
| against the long-term maintenance requirement of the JuMP ecosystem. | ||
|
|
||
| It was inspired by similar policies in [SymPy](https://docs.sympy.org/dev/contributing/ai-generated-code-policy.html) | ||
| and [SciPy](https://scipy.github.io/devdocs/dev/conduct/ai_policy.html). | ||
|
|
||
| ## Communication | ||
|
|
||
| This part of the policy applies to all communication in our [community forum](https://jump.dev/forum), | ||
| [developer chatroom](https://jump.dev/chatroom), and [GitHub repositories](https://github.com/jump-dev). | ||
|
|
||
| Do not use AI to generate written communication. Write in your own words. | ||
| Human-to-human communication is essential for an open source community to thrive. | ||
|
|
||
| If English is not your first language, consider providing both a machine | ||
| generated translation into English and the original text in your preferred | ||
| language. | ||
|
|
||
| ## Responsibility | ||
|
|
||
| You are responsible for any code you submit to JuMP's repositories. You must | ||
| understand and be able to explain the code you submit as well as the existing | ||
| related code. It is not acceptable to submit a patch that you cannot understand | ||
| and explain in your own words. | ||
|
|
||
| If you use AI to automatically generate descriptions, please first start with a | ||
| human-written description of your changes, and then provide a properly | ||
| identified (see [Disclosure](@ref)) and polished AI summary. | ||
|
|
||
| ## Copyright | ||
|
|
||
| All code in JuMP-related repositories is released under an open source license | ||
| (the exact license depends on the repository). Contributors license their code | ||
| under the same license. That means contributors must own the copyright of any | ||
| code you submit. It is your responsibility to not infringe on others copyright. | ||
| We will reject any pull requests where the copyright is in question. | ||
|
Member
Author
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. Here's a case: |
||
|
|
||
| ## Disclosure | ||
|
|
||
| You must disclose whether AI has been used to assist in the development of your | ||
| pull request. If so, you must document which tools have been used, how they | ||
| were used, and specify what code or text is AI generated. We will reject any | ||
| pull request that does not include the disclosure. | ||
|
|
||
| ## Pull Requests | ||
|
|
||
| When authoring new code in JuMP, keep in mind that the JuMP developers' two | ||
| biggest bottlenecks are: | ||
|
|
||
| 1. capacity for code review of new pull requests | ||
| 2. on-going support and maintenance of existing features. | ||
|
|
||
| For these reasons, if you want to add a new feature or undertake a large | ||
| refactor, please open an issue to discuss what you want to change _before_ | ||
| opening a pull request. In the issue, describe what you want to change and why | ||
| it matters to you. | ||
|
|
||
| Large pull requests that add new features not previously discussed in an issue | ||
| may be closed without review, even if they are correct and demonstrably useful. | ||
|
|
||
| ## AI Agents | ||
|
|
||
| The use of an AI agent that writes code and then submits a pull request | ||
| autonomously is not permitted. A human must check any generated code and submit | ||
| a pull request according to the [Responsibility](@ref) section above. | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Totally agree