Add AGENTS.md with agent guidelines#403
Conversation
Adds agent guidelines covering development setup, pre-commit, branching, commits, testing, pull request workflow (including Copilot review and squash-merge conventions), release process, and codebase references. Also ignores `.claude/` in .gitignore to keep local Claude Code settings out of version control. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds repository-level guidance for AI agents to follow consistent local workflows and PR/release practices, and prevents local Claude Code config from being committed.
Changes:
- Added
AGENTS.mdwith development, pre-commit, branching/commit, testing, PR, and release process guidance. - Updated
.gitignoreto exclude.claude/from version control.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| AGENTS.md | Introduces standardized instructions for agents (setup, tooling invocation, PR/release workflow). |
| .gitignore | Ignores local Claude Code settings directory. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #403 +/- ##
=======================================
Coverage 85.30% 85.30%
=======================================
Files 12 12
Lines 939 939
=======================================
Hits 801 801
Misses 138 138 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Pre-commit: check executability (-x) and show invocation via $PRE_COMMIT - Bot account: recommend fine-grained PAT with explicit permissions instead of broad repo scope - gh pr create: use heredoc for body to avoid shell quoting issues - Squash message: standardise canonical format (heading outside <details>, content inside), update gh pr edit snippet to match and use heredoc Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds repository-specific guidance for AI agents working in this repo, and ensures local Claude Code configuration isn’t committed.
Changes:
- Add
AGENTS.mddocumenting development setup, pre-commit usage, branching/commits, testing, PR workflow, release process, and codebase references. - Ignore
.claude/in.gitignoreto keep local Claude Code settings out of version control.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
AGENTS.md |
New agent workflow guidelines and repository references, including CLI snippets for pre-commit and GitHub PR workflow. |
.gitignore |
Adds .claude/ ignore entry. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Pre-commit: add explicit guard when PRE_COMMIT is unset after discovery
- gh pr edit: use unquoted heredoc delimiter so ${TRIMMED} expands correctly
- Trimming: replace echo with printf for portability
- Auto-generated docs: fix hook id (docs-api-reference) and CLI command
(create-api-reference-docs)
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds repository-local guidance for AI agents to work consistently with the repo’s development workflow, and prevents local Claude Code settings from being committed.
Changes:
- Introduces
AGENTS.mdwith development, pre-commit, branching/commits, testing, PR workflow, and release-process guidance. - Updates
.gitignoreto exclude.claude/.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| AGENTS.md | Adds detailed agent workflow guidance (setup, pre-commit invocation, PR workflow, release steps, codebase pointers). |
| .gitignore | Ignores .claude/ to keep local Claude Code config out of version control. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Quote $PRE_COMMIT invocation to handle paths with spaces - Fix --reviewer flag value: use copilot (login), not @copilot (mention) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds repository-specific operating guidelines for AI agents (and Claude Code), and ensures local Claude Code settings aren’t committed.
Changes:
- Add
AGENTS.mddocumenting development setup, pre-commit usage, branching/commits, testing, PR workflow, release process, and codebase references. - Update
.gitignoreto exclude.claude/.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| AGENTS.md | New agent guidelines document covering local dev workflow, PR/release procedures, and key codebase references. |
| .gitignore | Ignores local .claude/ configuration directory. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Initialize PRE_COMMIT= before the discovery loop so the guard cannot pass on a stale environment variable - Revert --reviewer "copilot" back to --reviewer "@copilot": the official GitHub Copilot docs explicitly use the @-prefixed form Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds repository-specific guidance for AI agents/contributors, covering local dev workflow, pre-commit/test invocation, PR creation/iteration, and the release process; also keeps local Claude Code settings out of version control.
Changes:
- Add
AGENTS.mdwith detailed agent/developer workflow guidelines (pre-commit, branching, commits, testing, PR/review iteration, release process, codebase references). - Update
.gitignoreto ignore.claude/.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| AGENTS.md | New contributor/agent guidelines document, including shell snippets for pre-commit and GitHub CLI PR workflows. |
| .gitignore | Ignores .claude/ to prevent committing local Claude Code configuration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Use printf '%s\n' to safely expand $TRIMMED, then append the static squash-message template via a quoted <<'EOF' heredoc. This avoids shell expansion of $ or backticks in the commit message content while still correctly substituting the trimmed PR body. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds repository-specific operating guidelines for AI agents and ensures local Claude Code settings aren’t committed, aligning contributor workflows around consistent setup, checks, PR hygiene, and release steps.
Changes:
- Add
AGENTS.mddocumenting development, pre-commit, branching/commits, testing, PR workflow, and release process guidelines. - Update
.gitignoreto exclude.claude/from version control.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| AGENTS.md | New contributor/agent workflow guidelines (setup, pre-commit usage, PR/review conventions, release steps, codebase references). |
| .gitignore | Ignore local Claude Code configuration directory .claude/. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The guard exits with an error when no binary is found; the prose now reflects this rather than suggesting to ask the user before the guard even runs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
A PR should not be declared ready until all CI checks pass, not just until Copilot accepts it. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace the ad-hoc CI step (checking only after Copilot accepts) with the pattern from SemanticMatter/ds-language: wait for CI after each push, use the wait time to address review comments, and only request a re-review once checks are green. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
'Stop the iteration' should come after the PR description review, not before it. Match the exact phrasing from SemanticMatter/ds-language. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds a repository-level AGENTS.md to standardize how AI agents (and tools like Claude Code) should work in this repo, and prevents local Claude configuration from being committed.
Changes:
- Introduces
AGENTS.mdwith end-to-end agent workflow guidance (setup, pre-commit, branching/commits, testing, PR workflow, release process, codebase pointers). - Updates
.gitignoreto exclude.claude/from version control.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| AGENTS.md | Adds comprehensive agent guidelines, including pre-commit invocation, PR/squash conventions, and release workflow steps. |
| .gitignore | Ignores .claude/ to keep local Claude Code settings out of the repo. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
'Use lowercase and hyphens only' was ambiguous about whether / was allowed. Reworded to make clear both components use lowercase + hyphens and / is the separator between them. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing agent documentation and ignores local Claude Code config, improving consistency for AI-assisted workflows in this repository.
Changes:
- Introduces
AGENTS.mdwith end-to-end guidelines (setup, pre-commit invocation, branching/commits, testing, PR workflow, and release process). - Updates
.gitignoreto exclude.claude/from version control.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| AGENTS.md | New guide covering development workflow, PR conventions, and release steps for AI agents/tools. |
| .gitignore | Adds .claude/ ignore entry to keep local Claude settings untracked. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
AGENTS.mdwith guidelines for AI agents (and Claude Code) working in this repository: development setup, pre-commit binary discovery, branching, commit style, testing, pull request workflow (Copilot review, squash-merge conventions, PR iteration including CI checks), release process, and codebase references..claude/to.gitignoreto keep local Claude Code settings out of version control.Test plan
AGENTS.mdrenders correctly on GitHub.claude/is excluded fromgit statusafter the mergeSquash commit message
Click to view squash commit message