Skip to content

[TEMPLATE] apply ASDF AI Policy - #10855

Draft
zacharyburnett wants to merge 1 commit into
spacetelescope:mainfrom
zacharyburnett:template/ai_policy
Draft

zacharyburnett wants to merge 1 commit into
spacetelescope:mainfrom
zacharyburnett:template/ai_policy

Conversation

@zacharyburnett

@zacharyburnett zacharyburnett commented Sep 10, 2026

Copy link
Copy Markdown
Collaborator

Description

  1. Adds the ASDF AI policy verbatim; here's a diff between STScI AI policy and ASDF AI policy:
6a7
>    2. The use of autonomous AI agents to submit issues, pull requests, or comments is not allowed. Accounts found to be doing so will be banned.
13c14,15
<    2. Committers are encouraged to apply a label of `ai-assisted` to pull requests that leveraged AI tools.
---
>    2. Contributors **must** disclose whether AI was used to assist in the development of a pull request. If so, you must specify which tools were used and how they were used. PRs that do not include this disclosure will be closed.
>    3. Committers are encouraged to apply a label of `ai-assisted` to pull requests that leveraged AI tools.
15,16c17,20
<    1. The pull request process is collaborative and iterative. Contributors are expected to actively engage with reviewer feedback themselves. Copying and pasting replies to / from a generative AI tool does not count as engaging with the reviewer.
<       All pull requests must be reviewed by a human other than the contributor.
---
>    1. AI should not be used to generate comments when communicating with maintainers. Issues and pull requests should be described in your own words. Any use of AI must be disclosed.
>    2. The pull request process is collaborative and iterative. Contributors are expected to actively engage with reviewer feedback themselves. Copying and pasting replies to / from a generative AI tool does not count as engaging with the reviewer.
>    3. If using AI tools for translation, please write in your native language and include the AI translation in a quote block following the original text.
>    4. All pull requests must be reviewed by a human other than the contributor.
  1. applies the pull request template from the STScI package template

Tasks

  • If you have a specific reviewer in mind, tag them.
  • add a build milestone, i.e. Build 12.0 (use the latest build if not sure)
  • Does this PR change user-facing code / API? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see changelog readme for instructions)
      • if your change breaks step-level or public API (as defined in the docs), also add a changes/<PR#>.breaking.rst news fragment
    • update or add relevant tests
    • update relevant docstrings and / or docs/ page
    • start a regression test and include a link to the running job (click here for instructions)
      • Do truth files need to be updated ("okified")?
        • after the reviewer has approved these changes, run okify_regtests to update the truth files
  • if a JIRA ticket exists, make sure it is resolved properly

Generative AI Usage Disclosure

no genAI tools used

@zacharyburnett zacharyburnett self-assigned this Sep 10, 2026
@zacharyburnett
zacharyburnett requested review from a team, jhunkeler and pllim as code owners September 10, 2026 15:01
@github-actions github-actions Bot added documentation automation Continuous Integration (CI) and testing automation tools labels Sep 10, 2026
@zacharyburnett
zacharyburnett enabled auto-merge (squash) September 10, 2026 15:02

@pllim pllim left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I don't think I am the one who should approve. That should be Tyler/Melanie. Left some comments though. Thanks!

Comment thread .cruft.json Outdated
"manage_changelog_with_towncrier": true,
"publish_docs_to": "readthedocs.io",
"task_runner": "tox",
"python_version": ">=3.12",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Hmm so this file duplicates stuff from pyproject.toml . Will we remember to update this when we update the other file? 🤔

@zacharyburnett zacharyburnett Sep 10, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

yes unfortunately it's duplicated here; we could maybe remove that option from the template in a future update, since it doesn't seem to be useful in practice to have it here EXCEPT for the case where a project builds ABI3, where the minimum Python version has to be defined multiple times in pyproject.toml and setup.py

Comment thread AI_POLICY.md

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Do we have some sort of automation to help enforce this policy?

Does the PR template also need updating?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

the only automation we have right now across our repos is https://github.com/peakoss/anti-slop, currently deployed in stcal: https://github.com/spacetelescope/stcal/blob/main/.github/workflows/quality.yml

otherwise, we could do something like auto-close PRs except for from maintainers or users who've already been assigned to an issue. That has pros and cons that would need to be discussed

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Ah, but if you want to limit who can open PR, there is a simpler built-in option:

Screenshot 2026-09-10 114348

Not saying we should do that though.

@codecov

codecov Bot commented Sep 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.89%. Comparing base (125f9c4) to head (62a5bfa).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10855      +/-   ##
==========================================
+ Coverage   87.86%   87.89%   +0.02%     
==========================================
  Files         372      372              
  Lines       40361    40379      +18     
==========================================
+ Hits        35464    35491      +27     
+ Misses       4897     4888       -9     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@pllim pllim added this to the Build 13.2 milestone Sep 10, 2026
@zacharyburnett zacharyburnett changed the title apply ASDF AI Policy and sync with package template [TEMPLATE] apply ASDF AI Policy and pull request template, and sync with package template Sep 10, 2026
@zacharyburnett zacharyburnett changed the title [TEMPLATE] apply ASDF AI Policy and pull request template, and sync with package template [TEMPLATE] apply ASDF AI Policy and sync with package template Sep 10, 2026
@zacharyburnett
zacharyburnett marked this pull request as draft September 14, 2026 16:54
auto-merge was automatically disabled September 14, 2026 16:54

Pull request was converted to draft

@zacharyburnett zacharyburnett changed the title [TEMPLATE] apply ASDF AI Policy and sync with package template [TEMPLATE] apply ASDF AI Policy Sep 14, 2026
@zacharyburnett

Copy link
Copy Markdown
Collaborator Author

splitting template sync off to #10863 because we're still waiting for the chief engineers to reach a consensus on an AI policy

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

Labels

automation Continuous Integration (CI) and testing automation tools documentation no-changelog-entry-needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants