Skip to content

docs: adopt agent conventions for this repository#59

Merged
xirong merged 1 commit into
ai/agents-md-templatefrom
ai/repo-agent-conventions
Jun 11, 2026
Merged

docs: adopt agent conventions for this repository#59
xirong merged 1 commit into
ai/agents-md-templatefrom
ai/repo-agent-conventions

Conversation

@xirong

@xirong xirong commented Jun 11, 2026

Copy link
Copy Markdown
Owner

Summary

PR 3 of 4 in the v2.1.0 stack, based on the AGENTS.md template PR. Merge after it.

This repository starts following the conventions the handbook recommends:

  • Adds the repository's own root AGENTS.md (structure, required checks, content rules, forbidden operations, commit conventions)
  • Adds an AI-assisted contribution section to CONTRIBUTING.md and 00-meta/contributing.md, plus a PR checklist item for declaring AI assistance
  • Includes AGENTS.md in the check-docs.py scan roots
  • Restores the template's link to the root AGENTS.md as a real-world example, and links agent conventions from both root READMEs

AI involvement

  • Tool: Claude Code
  • Task boundary: repository meta files only, no handbook article content changed
  • Suggested human review focus: the forbidden-operations list in AGENTS.md, since it constrains all future agent sessions in this repository

Verification

  • python3 scripts/check-docs.py passes (AGENTS.md now included, 226 files)
  • python3 scripts/check-links.py --no-external passes

🤖 Generated with Claude Code

Add the repository's own AGENTS.md, declare AI-assisted contribution
rules in the contributing guides, and include AGENTS.md in the docs
checks.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@xirong xirong merged commit ec3cab0 into ai/agents-md-template Jun 11, 2026
2 checks passed
xirong added a commit that referenced this pull request Jun 11, 2026
PRs #58, #59, and #60 were merged into their stacked base branches
before those branches were retargeted to master. This merge brings
the aggregated content of all three onto master.

* origin/ai/repo-agent-conventions:
  docs(ai-native): expand multi-agent and stacked PR guides
  docs: adopt agent conventions for this repository
  docs(templates): add AGENTS.md template
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