Skip to content

Add AI policy documentation and usage disclosure in PR template - #1419

Open
danielfromearth wants to merge 4 commits into
mainfrom
add-ai-policy
Open

Add AI policy documentation and usage disclosure in PR template#1419
danielfromearth wants to merge 4 commits into
mainfrom
add-ai-policy

Conversation

@danielfromearth

@danielfromearth danielfromearth commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Description

This change:

  • adds an AI policy document (primarily adapted from SciPy, with modifications based on STAC and qutip) to clarify responsibilities, disclosure, code quality, copyright, communication, and use of AI agents.
  • adds a checkbox to the PR template

This is an outgrowth of the AI guidance, contributions, automations (PR #1294) discussion.


AI usage disclosure (❗This subsection is added by this PR❗)

Using AI tools is welcome. Per our AI Policy,
we just ask that you disclose any use of generative AI tools in this contribution.

  • I have disclosed AI tool usage below, or confirmed that no AI tools were used

I used Claude Opus 4.8 to assist with reviewing and extracting relevant wording from various repositories' AI policy documentation. The final wording is my own.


"Ready for review" checklist

  • Place this Pull Request (PR) in draft until it is ready for review (see below)
  • Please review our Pull Request Guide
  • Mark "ready for review" after following instructions in the guide

Merge checklist

  • PR title is descriptive
  • PR body contains links to related and resolved issues (e.g. closes #1)
  • If needed, CHANGELOG.md updated
  • If needed, docs and/or README.md updated
  • If needed, unit tests added (unsure how? see below!)
  • All checks passing (tip: comment pre-commit.ci autofix if pre-commit is failing)
  • At least one approval

Need help? We welcome contributions at every experience level. You don't have to
write tests alone — open your PR and ask for help. It's also fine to let GitHub run tests
for you, via Continuous Integration (CI),
instead of running them locally. If anything fails and you're not sure why, just
mention @earthaccess-dev/maintainers in a comment and we'll work with you!

Updated AI policy document to clarify responsibilities, disclosure, code quality, copyright, communication, and use of AI agents.
@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown

Binder 👈 Launch a binder notebook on this branch for commit 4a8b13d

I will automatically update this comment whenever this PR is modified

Binder 👈 Launch a binder notebook on this branch for commit 8da5f52

Binder 👈 Launch a binder notebook on this branch for commit 9be1283

Binder 👈 Launch a binder notebook on this branch for commit 07127d1

@danielfromearth

Copy link
Copy Markdown
Contributor Author

pre-commit.ci autofix

@danielfromearth danielfromearth changed the title Add AI policy from SciPy Add AI policy Aug 4, 2026
@danielfromearth danielfromearth added impact: documentation Use this label for issues related to Improvements or additions to documentation. impact: governance Issues that impact the project's governance or decision-making process. impact: LLM Issues/Discussions related to large language model (LLM) support. labels Aug 4, 2026
@Sherwin-14

Sherwin-14 commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

AI Contribution Policy Reference

⭐ = top picks, worth a look at   |   📌 Compiled from open-source-ai-contribution-policies

Project Home Page Policy Disclosure Required Copyright Statement Review
Apache Airflow 🏠 📄
attrs 🏠 📄
conda 🏠 📄
CuPy 🏠 📄
Django 🏠 📄
FastAPI 🏠 📄
Matplotlib 🏠 📄
NumPy 🏠 📄
pip 🏠 📄
qutip 🏠 📄
scikit-learn 🏠 📄
SciPy 🏠 📄
STAC 🏠 📄
SymPy 🏠 📄

- rename references
- change license from BSD to MIT
- update acknowledgements
Comment thread docs/ai_policy.md
Comment on lines +5 to +7
images, or generate human-like communication.

## Responsibility

Copy link
Copy Markdown
Contributor Author

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:

Suggested change
images, or generate human-like communication.
## Responsibility
images, or generate human-like communication.
## Scope
This policy applies to contributions from the wider community. Automated
processes operated by the earthaccess maintainer team (for example, dependency
updates and other repository automations) run under separate maintainer
oversight and are not governed by the requirements below.
## Responsibility

…ge in CHANGELOG.md

Sourcing of the text:
- The disclosure section opening and "document which tool(s)..." sentences retained near-verbatim from the SciPy/NumPy policy this document is based on (https://github.com/scipy/scipy/blob/7d97d331d81a9ad8b59baa63bc19e84e8d6f8c03/doc/source/dev/conduct/ai_policy.rst?plain=1#L25).
- Mandatory PR-template checkbox, including an explicit "no AI tools used" case, from qutip's AI Tools Usage Disclosure (https://github.com/qutip/qutip/blob/fbfb1f8bf30284a6e077f0ac101a3bfb0f66050f/CONTRIBUTING.md?plain=1#L23); the checkbox-in-template approach also appears in STAC's policy (https://github.com/stac-utils/stac-utils.github.io/blob/4494ca45e0c65972d78abb9811418e97a78ee5a5/docs/ai-contribution-policy.md?plain=1#L41).
- The framing that disclosure exists to help reviewers, not to police or track contributors, follows STAC's stated purpose for labeling (https://github.com/stac-utils/stac-utils.github.io/blob/4494ca45e0c65972d78abb9811418e97a78ee5a5/docs/ai-contribution-policy.md?plain=1#L76).
@danielfromearth danielfromearth changed the title Add AI policy Add AI policy documentation and usage disclosure in PR template Aug 12, 2026
@danielfromearth
danielfromearth marked this pull request as ready for review August 12, 2026 20:33

@betolink betolink left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is good for an initial step, we can improve it as we go.

Comment thread docs/ai_policy.md
Do not waste developers' time by submitting code that
is fully or mostly generated by AI, and doesn't meet our standards.

## Copyright

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neat!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

impact: documentation Use this label for issues related to Improvements or additions to documentation. impact: governance Issues that impact the project's governance or decision-making process. impact: LLM Issues/Discussions related to large language model (LLM) support.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants