Skip to content

Commit 8d99f54

Browse files
Add repo AGENTS guidance standard
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent b11b310 commit 8d99f54

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Agents
2+
3+
## Purpose
4+
5+
Use this file to understand how agents should gather context and execute work in
6+
this repository.
7+
8+
## Core operating standard
9+
10+
1. Treat repository controls (linters, security checks, policies) as correct by
11+
default.
12+
2. Align implementation with controls before considering exceptions.
13+
3. If an exception is needed, make it explicit, minimal, and documented in code
14+
and PR context. Never bypass controls silently.
15+
16+
## Canonical context resolution
17+
18+
Determine repository identity from Git metadata (for example, `origin` remote and
19+
repository settings). Do not hardcode a specific owner or host unless the task
20+
explicitly requires it.
21+
22+
Process context in this order:
23+
24+
| Order | Source | What to read first | Why |
25+
| --- | --- | --- | --- |
26+
| 1 | Local repository | `README.md`, `CONTRIBUTING.md`, local docs index/start page | Local behavior and contribution rules are authoritative for this repo. |
27+
| 2 | Project/framework guidance | Framework or shared project docs referenced by this repo | Align with shared implementation patterns used by sibling repos. |
28+
| 3 | Central organization guidance | Organization-level docs and standards | Apply global policy after local/project specifics are known. |
29+
30+
## Documentation standards for commands and repos
31+
32+
1. Use canonical repository URLs in docs (full URLs such as
33+
`https://github.com/owner/repo`) instead of ambiguous short names.
34+
2. For install and synchronization instructions, provide equivalent examples for
35+
native shells on Windows, macOS, and Linux.

0 commit comments

Comments
 (0)