-
-
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 2 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
Some comments aren't visible on the classic Files Changed page.
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,76 @@ | ||
| # AI Policy | ||
|
|
||
| This document describes how the JuMP developers will manage and respond to | ||
| AI-assisted contributions to 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 speak for you by copy-pasting a conversation in-and-out of a | ||
| chatbot. | ||
|
Check failure on line 15 in docs/src/developers/ai_policy.md
|
||
|
|
||
| We would rather speak to you directly, errors and grammatical mistakes included. | ||
|
Check warning on line 17 in docs/src/developers/ai_policy.md
|
||
|
|
||
| If English is not your first language, consider providing both a machine | ||
| generated translation into English and the original text in your preferred | ||
| language. | ||
|
|
||
| ## Code contributions | ||
|
|
||
| This part of the policy applies to all pull requests and issues in our | ||
| [GitHub repositories](https://github.com/jump-dev). | ||
|
|
||
| We expect and encourage users to use AI assistance when developing. You do not | ||
| need to disclose what parts you used AI assistance for, but you are responsible | ||
| for all code that you submit to JuMP. However, do not use AI to author the text | ||
| descriptions of pull requests and issues; see our [Communication](@ref) policy. | ||
|
|
||
| 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, 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. | ||
|
|
||
| ## New Contributors | ||
odow marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| The JuMP developers welcome and encourage new contributors. | ||
|
|
||
| The best ways you can get involved are: | ||
|
|
||
| 1. **Find and report bugs**: we can't fix things that we don't know about. There | ||
| are always new bugs (or inconsistencies that we should better document) to | ||
| find. Report a bug by [opening a GitHub issue](https://github.com/jump-dev/JuMP.jl/issues). | ||
|
|
||
| Using AI tools to find bugs is acceptable, but you are responsible for | ||
| understanding and explaining _why_ the issue is a bug (see our | ||
| [Communication](@ref) policy). Rather than copy-pasting only the content of | ||
| the AI analysis into the issue, first explain what you did to find and | ||
| verify the bug, and then copy-paste the AI tool's output. | ||
|
|
||
| Also note that there are many repositories in the JuMP ecosystem. Don't worry | ||
| if you open an issue in the "wrong" one; we can easily transfer it to the | ||
| correct repository. | ||
|
|
||
| 2. **Tell us about confusing parts of the documentation**: if you get stuck | ||
| trying to do something in JuMP, it means we didn't document things well | ||
| enough. If you have suggestions for new tutorials we could add or how we | ||
| could improve the documentation please leave a comment at | ||
| ["Suggestions for documentation improvements"](https://github.com/jump-dev/JuMP.jl/issues/2348). | ||
|
|
||
| 3. **Make your own packages**: write your own solver or JuMP extension under | ||
| your personal account. There are no rules here. Vibe code as much as you | ||
| like. Tell us about the things you have created by posting on the | ||
| [community forum](https://jump.dev/forum), or give a talk at a | ||
| [JuMP-dev workshop](https://jump.dev/categories/#jump-dev). | ||
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.