docs: add coding agent guidelines#410
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot couldn't run its full agentic review because no GitHub Actions runner was available. Make sure your repository has a runner available to run Copilot's review, or add a copilot-setup-steps.yml file specifying one with the runs-on attribute. See the docs for more details.
Adds repository-level guidance for coding agents and aligns contributor/PR guidance with Conventional Commits requirements.
Changes:
- Document Conventional Commits format in
CONTRIBUTING.mdand reference it for PR titles. - Add
AGENTS.mdwith repo-specific instructions for coding agents (scope, C++ rules, build/test, delivery). - Update PR template messaging and add
CLAUDE.mdpointing to agent guidance.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| CONTRIBUTING.md | Adds Conventional Commits policy for commit messages and PR titles. |
| CLAUDE.md | Introduces a pointer to agent guidelines (currently minimal/ambiguous). |
| AGENTS.md | Adds comprehensive coding-agent guidance including build/test commands. |
| .github/PULL_REQUEST_TEMPLATE.md | Updates template note to require Conventional Commits PR titles. |
Comments suppressed due to low confidence (1)
CLAUDE.md:17
CLAUDE.mdcurrently contains only the literal textAGENTS.md, which is easy to miss and may not be treated as a link by renderers/tools. If the intent is to redirect readers/tools to the agent guidelines, consider making this an explicit Markdown link (and optionally a one-line explanation) so it’s unambiguous and clickable.
# AGENTS.md
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Linked issue: N/A
Add repository-level guidance for coding agents, document Conventional Commits requirements for commit messages and pull request titles, align the pull request template with that policy, recommend separate follow-up commits for review changes, and expose the same instructions to Claude-compatible tooling through a
CLAUDE.mdsymbolic link.Tests
git diff --cached --checkcodespell --ignore-words .codespell_ignore AGENTS.md CONTRIBUTING.md .github/PULL_REQUEST_TEMPLATE.mdCLAUDE.mdis a symbolic link toAGENTS.mdand resolves to identical content.pre-commitwas not run because the local Python installation is missing the_sqlite3module.API and Format
No public API, storage format, or protocol changes.
Documentation
Adds
AGENTS.md, linksCLAUDE.mdto the same guidance, and updates contributor and pull request documentation.Generative AI tooling
Generated-by: Codex (GPT-5)