-
Notifications
You must be signed in to change notification settings - Fork 148
Add AI policy documentation and usage disclosure in PR template #1419
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
danielfromearth
wants to merge
4
commits into
main
Choose a base branch
from
add-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.
+98
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
4a8b13d
Add AI policy from SciPy
danielfromearth 8da5f52
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 9be1283
docs: adapt ai policy text from SciPy to earthaccess
danielfromearth 07127d1
docs: revise AI disclosure, add PR template checkbox, and record chan…
danielfromearth 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
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 | ||
|
|
||
| "AI" herein refers to generative AI tools like large language models (LLMs) | ||
| that can generate, edit, and review software code, create and manipulate | ||
| images, or generate human-like communication. | ||
|
|
||
| ## Responsibility | ||
|
|
||
| You are responsible for any code you submit to earthaccess's repositories, regardless | ||
| of whether it was manually written or generated by AI. 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 yourself. | ||
| In explaining your contribution, do not use AI to automatically generate | ||
| descriptions. | ||
|
|
||
| ## Disclosure | ||
|
|
||
| You must disclose whether AI has been used to assist in the development of | ||
| your pull request. The pull request template includes a disclosure checkbox; | ||
| please complete it for every pull request, including those where no AI tools | ||
| were used. If AI has been used, document which tool(s) were 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. | ||
|
|
||
| Disclosure helps reviewers understand and give appropriate attention to your | ||
| contribution, and keeps our review process transparent. As with any | ||
| contribution, please make sure you understand anything you submit so you can | ||
| answer questions that come up during review. | ||
|
|
||
| ## Code Quality | ||
|
|
||
| Code generated by AI can be of low quality. Contributors are expected to | ||
| submit code that meets earthaccess's standards. We will reject pull requests that we | ||
| deem being "[AI slop](https://en.wikipedia.org/wiki/AI_slop)". | ||
| Do not waste developers' time by submitting code that | ||
| is fully or mostly generated by AI, and doesn't meet our standards. | ||
|
|
||
| ## Copyright | ||
|
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. Neat! |
||
|
|
||
| All code in earthaccess is released under the MIT license. | ||
| Contributors to earthaccess license their code under the same license when it is | ||
| included into earthaccess's version control repository. That means contributors must | ||
| own the copyright of any code submitted to earthaccess or must include the | ||
| MIT-compatible open source license(s) associated with the submitted code | ||
| in the patch. Code generated by AI may infringe on copyright and it is the | ||
| submitter's responsibility to not infringe. We reserve the right to reject any pull | ||
| requests, AI generated or not, where the copyright is in question. | ||
|
|
||
| ## Communication | ||
|
|
||
| When interacting with developers (forum, discussions, | ||
| issues, pull requests, etc.) do not use AI to speak for you, except for | ||
| translation or grammar editing. If the developers want to chat with a chatbot, | ||
| they can do so themselves. Human-to-human communication is essential for an | ||
| open source community to thrive. | ||
|
|
||
| ## 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' section above. | ||
|
|
||
| ## Other Resources | ||
|
|
||
| While these do not formally form part of earthaccess's AI policy, the following resources | ||
| may be helpful in understanding some pitfalls associated with using AI to contribute to | ||
| earthaccess: | ||
|
|
||
| - https://llvm.org/docs/AIToolPolicy.html | ||
| - https://blog.scientific-python.org/scientific-python/community-considerations-around-ai/ | ||
| - https://github.com/melissawm/open-source-ai-contribution-policies | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
| We thank the SciPy developers for their AI policy, upon which this document is | ||
| largely based, and the SymPy developers, upon whose policy SciPy's is in turn based. | ||
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.
I wonder: do we want to exclude automated maintenance processes, like GitHub Actions, from the requirements? Perhaps adding a "Scope" section to the AI policy such as: