docs: create AGENTS.md with CI-enforced rules for coding agents#754
Open
sergio-sisternes-epam wants to merge 3 commits intomicrosoft:mainfrom
Open
docs: create AGENTS.md with CI-enforced rules for coding agents#754sergio-sisternes-epam wants to merge 3 commits intomicrosoft:mainfrom
sergio-sisternes-epam wants to merge 3 commits intomicrosoft:mainfrom
Conversation
Closes microsoft#695 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a repository-root AGENTS.md intended to be the authoritative, agent-readable checklist of CI-enforced rules and conventions for working in this codebase (closing #695), and ensures it is tracked and documented.
Changes:
- Add new
AGENTS.mdwith setup steps, pre-commit checklist, and pointers to.github/instructions/*. - Update
.gitignoreto unignore/AGENTS.mdwhile keeping otherAGENTS.mdfiles ignored. - Add a changelog entry under
## [Unreleased].
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
AGENTS.md |
New agent contract/checklist and pointers to detailed instruction files. |
.gitignore |
Ensures the root AGENTS.md is tracked despite a broader ignore pattern. |
CHANGELOG.md |
Records the addition of AGENTS.md under Unreleased/Added. |
added 2 commits
April 18, 2026 16:54
Address Copilot review feedback -- encoding check now covers all staged text files, not just .py files, matching the encoding rule scope.
Update docs/cli-reference.md (non-existent) to the actual path docs/src/content/docs/reference/cli-commands.md in two places.
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.
Summary
Creates
AGENTS.mdat the repository root -- the single authoritative entry point for AI coding agents working in this repository.Closes #695
What this file provides
A concise, machine-scannable contract covering every CI-enforced rule that agents could violate:
uv syncand verification commands.github/instructions/*.instructions.mdfilesDesign decisions
Top-level entry point, not a duplicate -- AGENTS.md contains directives and points to
.github/instructions/for detailed per-module rules. No content duplication.ASCII-only -- the entire file stays within printable ASCII (U+0020-U+007E), consistent with the encoding rules it documents.
103 lines -- concise and scannable. Agents get rules, not rationale.
CLI docs path corrected -- issue [FEATURE] Create root AGENTS.md documenting all CI-enforced rules for coding agents #695 referenced
docs/cli-reference.mdwhich doesn't exist. Used the actual path:docs/src/content/docs/reference/cli-commands.md..gitignoreupdated --AGENTS.mdwas in.gitignore(local development section). Added!/AGENTS.mdnegation to track the root file while keeping subdirectory AGENTS.md files ignored.Changes
AGENTS.md.gitignore!/AGENTS.mdnegation patternCHANGELOG.md[Unreleased] > AddedValidation
grep -Pn '[^\x09\x0a\x0d\x20-\x7e]')uv run pytest tests/unit tests/test_console.py -n auto --dist worksteal)