Skip to content

docs: require agent, model, and settings in AI disclosure - #42

Closed
mnriem wants to merge 1 commit into
mainfrom
mnriem-docs-ai-disclosure-agent-model
Closed

mnriem wants to merge 1 commit into
mainfrom
mnriem-docs-ai-disclosure-agent-model

Conversation

@mnriem

@mnriem mnriem commented Sep 10, 2026

Copy link
Copy Markdown
Owner

Description

Makes AI-assistance disclosure a hard requirement: when AI was used, the contributor must name the agent/tool, the model(s), the settings/mode (reasoning effort; autonomous vs. human-supervised), and the extent (docs vs. code generation) — in the PR or issue.

This is intentionally stricter than the prior "model optional" stance and is a deliberate maintainer policy decision.

Framing (important)

This disclosure is transparency, not a quality lever. It does not change the level of scrutiny a contribution receives — the same evidence bar applies to everyone, human and AI-assisted alike. A strong PR from a weak model still merges; a broken PR from a frontier model is still rejected. The point is visibility into which models/agents/settings are in use and to what extent, which helps maintainers judge whether AGENTS.md guidance needs refinement over time. It is never a merge-quality prior or a brand-based gate. The existing trivial spacing/typo-fix exception is preserved.

Changes

  • CONTRIBUTING.md (## AI contributions in Spec Kit): upgrade the requirement to name agent/tool + model(s) + settings/mode + extent; extend the AI-generated PR responses/comments clause to require the same; refresh both example disclosures; add the transparency (not scrutiny) rationale linking to AGENTS.md; update the "What we're looking for" disclosure bullet. Trivial-fix exception kept.
  • .github/PULL_REQUEST_TEMPLATE.md: keep the did / did-not checkboxes and add structured Agent/tool, Model(s), Settings/mode, and Extent fields, pre-filled with N/A.
  • .github/ISSUE_TEMPLATE/{bug_report,feature_request,agent_request}.yml: add a required free-form AI Disclosure field defaulted to N/A (issues are increasingly agent-authored too). Catalog-submission templates are intentionally left untouched — they feed content-neutral validation automation and don't ask about AI use.

Testing

  • Tested locally with uv run specify --help
  • Ran existing tests with uv sync && uv run pytest
  • Tested with a sample project (if applicable)
  • markdownlint-cli2 clean on changed markdown; git diff --check clean; issue-form YAML parses and the new required field validates.

Docs/policy-only change — no code paths touched.

AI Disclosure

  • I did not use AI assistance for this contribution

  • I did use AI assistance (details below)

  • Agent/tool: GitHub Copilot (coding agent)

  • Model(s): Claude Opus 4.8

  • Settings/mode: Autonomous, under maintainer review

  • Extent: Drafted the prose/template edits from the maintainer's specification; wording and framing reviewed by the maintainer before submission.

Make AI-assistance disclosure a hard requirement: when AI was used, the
author must name the agent/tool, the model(s), the settings/mode
(reasoning effort; autonomous vs. human-supervised), and the extent.

This is stricter than the prior "model optional" stance and is a
deliberate maintainer policy choice. It is framed as transparency, not a
quality lever: disclosure does not change the level of scrutiny a
contribution receives — the same evidence bar applies to everyone. It
gives maintainers visibility into which models/settings are used and to
what extent, which helps judge whether AGENTS.md guidance needs
refinement over time.

- CONTRIBUTING.md: upgrade the requirement, extend the PR
  responses/comments clause, refresh the example disclosures, and add the
  transparency rationale. Keep the trivial-fix exception.
- PULL_REQUEST_TEMPLATE.md: add structured Agent/tool, Model(s),
  Settings/mode, and Extent fields prefilled with N/A.
- bug_report, feature_request, agent_request issue forms: add a required
  AI Disclosure field defaulted to N/A.

Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@mnriem mnriem closed this Sep 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant