You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -49,19 +49,19 @@ See `.github/AI_GOVERNANCE.md` for the documentation taxonomy and “source of t
49
49
50
50
## Instruction & Prompt Expectations
51
51
- Instruction files live under `.github/instructions/` with `applyTo`, `name`, and `description` frontmatter only; keep content ≤ 200 lines with Purpose/Scope, Key Rules, Examples.
52
-
- Chat modes constrain role-specific behavior (managed/native/installer/technical-writer) and should be referenced when invoking Copilot agents.
52
+
- Chat modes constrain role-specific behavior (managed/native/installer/technical-writer) and should be referenced when invoking agents.
53
53
54
54
**Context7 Guidance:** When requesting API references, code examples, or library-specific patterns, consult Context7 first (for example, call `resolve-library-id` then `get-library-docs` or `search-code`). Prefer the Context7 libraries listed in `.vscode/context7-configuration.json` and include the resolved library ID in your prompt when possible. Context7 lookups are considered safe and are configured for auto-approval in this workspace.
55
55
56
-
## COPILOT.md Maintenance
56
+
## AGENTS.md Maintenance
57
57
1.**Detect** stale folders: `python .github/detect_copilot_needed.py --strict --base origin/<branch> --json .cache/copilot/detect.json`.
3.**Scaffold** (optional) when a file drifts from the canonical layout: `python .github/scaffold_copilot_markdown.py --folders Src/<Folder>`.
60
60
4.**Apply** the auto change-log from the planner: `python .github/copilot_apply_updates.py --plan .cache/copilot/diff-plan.json --folders Src/<Folder>`.
61
61
5.**Edit narrative sections** using the planner JSON (change counts, commit log, `reference_groups`), keeping human guidance short and linking to subfolder docs where possible.
62
-
6.**Validate** with `python .github/check_copilot_docs.py --only-changed --fail` (or use `--paths Src/Foo/COPILOT.md` for targeted checks).
62
+
6.**Validate** with `python .github/check_copilot_docs.py --only-changed --fail` (or use `--paths Src/Foo/AGENTS.md` for targeted checks).
63
63
7. When documentation exceeds ~200 lines or acts as a parent index, migrate to `.github/templates/organizational-copilot.template.md` and keep the parent doc as a navigation index.
64
-
8. Run `.github/prompts/copilot-folder-review.prompt.md` with the updated plan slice to simulate Copilot review before committing.
64
+
8. Run `.github/prompts/copilot-folder-review.prompt.md` with the updated plan slice to simulate an agent review before committing.
65
65
66
66
## CI & Validation Requirements
67
67
- GitHub Actions workflows live under `.github/workflows/`; keep them passing.
@@ -116,3 +116,4 @@ See `.github/AI_GOVERNANCE.md` for the documentation taxonomy and “source of t
116
116
-[ ] Refer back to this guide whenever you need repo-wide ground truth.
- Do not copy component descriptions into `.github/instructions/`.
17
17
- Do not restate rules in multiple places. Prefer linking.
18
-
- If a rule must be enforced by Copilot for a subtree, add a scoped `.instructions.md`; otherwise document it in the relevant `COPILOT.md`.
18
+
- If a rule must be enforced by agents for a subtree, add a scoped `.instructions.md`; otherwise document it in the relevant `AGENTS.md`.
19
19
20
20
## What goes where
21
21
22
-
### `.github/copilot-instructions.md`
22
+
### `.github/AGENTS.md`
23
23
Use for:
24
-
- One-page onboarding for Copilot: build/test commands, repo constraints, and links.
24
+
- One-page onboarding for agents: build/test commands, repo constraints, and links.
25
25
- Pointers to the curated instruction set and the component docs.
26
26
27
27
### `.github/instructions/*.instructions.md`
@@ -41,26 +41,31 @@ Use for:
41
41
-`terminal.instructions.md`
42
42
-`testing.instructions.md`
43
43
44
-
### `Src/**/COPILOT.md`
44
+
### `Src/**/AGENTS.md`
45
45
Use for:
46
46
- Where to start (entry points, key projects, typical workflows).
47
47
- Dependencies and cross-component links.
48
48
- Tests (where they live, how to run them).
49
49
50
-
Baseline expectations for a component COPILOT doc:
50
+
Baseline expectations for a component agent doc:
51
51
-**Where to start** (projects, primary entry points)
52
52
-**Dependencies** (other components/layers)
53
53
-**Tests** (test projects and the recommended `./test.ps1` invocation)
54
54
55
55
### `.github/agents/` and `.github/chatmodes/`
56
56
Use for:
57
57
- Role definitions, boundaries, and tool preferences.
58
-
- Do not put component architecture here; link to the component `COPILOT.md`.
58
+
- Do not put component architecture here; link to the component `AGENTS.md`.
59
+
60
+
## External standards alignment (post-2025)
61
+
-**AGENTS.md**: Supported as a simple, vendor-neutral instruction format by multiple tools (for example, Cursor’s project rules). Use plain Markdown with clear headings and concise rules.
62
+
-**MCP (Model Context Protocol)**: Use MCP for tool/data integration rather than vendor-specific plugins; MCP provides a standardized, versioned protocol for AI tool connectivity.
59
63
60
64
## Adding a new scoped instruction file
61
65
Add a new `.github/instructions/<name>.instructions.md` only when:
62
66
- The guidance is prescriptive (MUST/DO NOT), and
63
67
- It applies broadly or to a subtree, and
64
68
- It would be harmful if Copilot ignored it.
65
69
66
-
Otherwise, update the appropriate `Src/**/COPILOT.md`.
70
+
Otherwise, update the appropriate `Src/**/AGENTS.md`.
Copy file name to clipboardExpand all lines: .GitHub/agents/fieldworks.avalonia-expert.agent.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
name: "FieldWorks Avalonia UI Expert"
3
3
description: "Avalonia UI specialist agent (XAML + .NET) with a strong bias toward using Context7 for up-to-date Avalonia APIs and patterns. Designed for FieldWorks-style repo constraints: minimal diffs, strong testing discipline, and localization-first UI strings."
Copy file name to clipboardExpand all lines: .GitHub/agents/fieldworks.cpp-expert.agent.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
name: "FieldWorks C++ Expert"
3
3
description: "Native/C++ (and C++/CLI-adjacent) agent for FieldWorks (FLEx): fixes native build and test failures safely using the repo’s build order (native first), avoids risky interop changes, and validates via test.ps1 -Native and traversal builds."
Copy file name to clipboardExpand all lines: .GitHub/agents/fieldworks.winforms-expert.agent.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
name: "FieldWorks WinForms Expert"
3
3
description: "WinForms-focused agent for FieldWorks (FLEx): safe changes to .NET Framework (net48) WinForms UI, Designer-safe edits, localization via .resx, and efficient test-driven fixes using build.ps1/test.ps1."
Copy file name to clipboardExpand all lines: .GitHub/instructions/terminal.instructions.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ description: "Terminal command patterns for auto-approval in FieldWorks"
8
8
9
9
Commands with pipes (`|`), `&&`, or `2>&1` require manual approval. Use `scripts/Agent/` wrappers instead.
10
10
11
-
**MCP-first:** When the `ps-tools` MCP server is running, prefer MCP tools (`Git-Search`, `Read-FileContent`, `Invoke-AgentTask`, `build`, `test`, Copilot tools) instead of direct terminal commands. Use wrappers only when MCP is unavailable.
11
+
**MCP-first:** When the `ps-tools` MCP server is running, prefer MCP tools (`Git-Search`, `Read-FileContent`, `Invoke-AgentTask`, `build`, `test`, agent tools) instead of direct terminal commands. Use wrappers only when MCP is unavailable.
12
12
13
13
## Transformations
14
14
@@ -27,4 +27,8 @@ Commands with pipes (`|`), `&&`, or `2>&1` require manual approval. Use `scripts
27
27
|`Git-Search.ps1`| git show/diff/log/grep/blame |
28
28
|`Read-FileContent.ps1`| File reading with filtering |
29
29
30
-
**Build/test**: Run `.\build.ps1` or `.\test.ps1` directly—they're auto-approvable.
30
+
**Build/test**: Run `.\build.ps1` or `.\test.ps1` directly—they're auto-approvable.
31
+
## Beads CLI (auto-approvable patterns)
32
+
-`br` and `bv --robot-*` commands are auto-approvable **when they do not use pipes, `&&`, or redirection**.
33
+
- Prefer `--json`/`--robot` output and parse in the agent instead of piping to `jq`.
34
+
-`br sync --flush-only` does **not** run git; you must run git commands separately.
0 commit comments