Skip to content

docs: add agent instructions (AGENTS.md + .claude/CLAUDE.md)#57

Merged
j7an merged 1 commit into
mainfrom
docs/add-agent-instructions
May 16, 2026
Merged

docs: add agent instructions (AGENTS.md + .claude/CLAUDE.md)#57
j7an merged 1 commit into
mainfrom
docs/add-agent-instructions

Conversation

@j7an
Copy link
Copy Markdown
Owner

@j7an j7an commented May 16, 2026

Summary

Adds repository guidance for AI coding agents.

  • AGENTS.md (repo root) — tool-neutral entry point; imports the detailed guide via @.claude/CLAUDE.md so it is auto-discovered by agents that walk up from the working directory.
  • .claude/CLAUDE.md — the detailed guide.

What the guide covers

  • bats test commands (full suite, single file, single test via --filter) and the CI checks
  • The inline-sync invariantscripts/*.sh are the source of truth and are embedded verbatim inside the workflow YAMLs; check-inline-sync.sh enforces byte-for-byte equality, and lint-workflow-call.sh guards against caller-context refs
  • The dependency-cooldown scan pipeline and the release-selftag-releaserelease machinery
  • Conventions: Bash 3.2 compatibility, SHA-pinned actions, Conventional Commits driving release bumps

No issue to close.

Add repository guidance for AI coding agents. AGENTS.md at the repo
root is the tool-neutral entry point and imports the detailed guide
via `@.claude/CLAUDE.md`.

The guide covers the bats test commands, the inline-sync invariant
(scripts/*.sh embedded verbatim in workflow YAMLs), the release
machinery, and the Bash 3.2 / SHA-pinning conventions.
@j7an j7an merged commit 3a10cd6 into main May 16, 2026
4 checks passed
@j7an j7an deleted the docs/add-agent-instructions branch May 16, 2026 05:15
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