Skip to content

Commit 8ccea63

Browse files
CopilotTonyCap
andcommitted
Update remaining documentation files for agents/chatmodes migration
Co-authored-by: TonyCap <162155315+TonyCap@users.noreply.github.com>
1 parent b793018 commit 8ccea63

5 files changed

Lines changed: 19 additions & 9 deletions

File tree

.github/copilot-instructions.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ Exceptions:
396396
- Obtain at least one reviewer acknowledgment of the exception in review comments
397397

398398
References:
399-
- Chat modes (Developer/Tester) MUST reference this section instead of hardcoding numeric targets.
399+
- Agents (Developer/Tester) MUST reference this section instead of hardcoding numeric targets.
400400
- Project-specific overrides, if any, MUST be documented here to remain authoritative.
401401

402402
---
@@ -423,7 +423,9 @@ NOTE: This section may be removed when used as template, hence the disclaimer
423423

424424
The `.github` directory contains several subdirectories and files that organize configuration, prompts, and instructions for Copilot and other AI agents:
425425

426-
- `chatmodes/`: Contains chat mode configuration files (e.g., `custom-mode.chatmode.md`) that define custom conversational behaviors for Copilot and other agents.
426+
- `agents/`: Contains agent configuration files (e.g., `Developer.agent.md`) that define custom conversational behaviors for Copilot and other agents. As of October 2025, GitHub renamed "Chat Modes" to "Agents".
427+
428+
- `chatmodes/`: *(Deprecated)* Contains chat mode configuration files (e.g., `Developer.chatmode.md`) for backward compatibility. New development should use the `agents/` directory.
427429

428430
- `instructions/`: Holds instruction files for backend, frontend, and documentation. These guide Copilot and other agents on best practices and project-specific rules. You must apply these instructions to relevant files in the repository.
429431
- `backend.instructions.md`

CONTRIBUTING.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ Major changes to existing configurations should be discussed in an issue before
7777
- **Read SSOT files**: Understand the authoritative guidelines in:
7878
- `.github/copilot-instructions.md` - Core policies and workflow
7979
- `.github/instructions/docs.instructions.md` - Documentation standards
80-
- `.github/chatmodes/README.md` - Chat mode authoring guide
80+
- `.github/agents/README.md` - Agent authoring guide
81+
- `.github/chatmodes/README.md` - Chat mode authoring guide (deprecated)
8182
- `README.md` - Repository overview and SSOT source map
8283

8384
### 2. Create an Issue (Recommended)
@@ -137,8 +138,8 @@ git checkout -b <type>/<brief-description>
137138

138139
**Examples**:
139140

140-
- `feat: Add security-focused chat mode with threat modeling`
141-
- `fix: Correct typo in Developer.chatmode.md`
141+
- `feat: Add security-focused agent with threat modeling`
142+
- `fix: Correct typo in Developer.agent.md`
142143
- `docs: Improve explanation of prompting techniques`
143144

144145
#### Adding Comments to Prompts
@@ -253,7 +254,9 @@ plans/ # Project planning documents
253254
- Use proper Markdown formatting
254255
- Avoid emojis in formal documentation (except in this guide for visual clarity)
255256

256-
### Prompts and Chat Modes
257+
### Prompts and Agents
258+
259+
> **Note:** As of October 2025, GitHub renamed "Chat Modes" to "Agents". New contributions should use the `.github/agents/` directory with the `.agent.md` extension. The `.github/chatmodes/` directory is maintained for backward compatibility.
257260
258261
- Include comprehensive HTML comments
259262
- Explain prompting techniques explicitly

docs/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@ This directory contains all project-related documentation, organized into subdir
1616

1717
## Writing Documentation Using AI
1818

19-
There are three examples of how to influence and use AI to write documentation in this repository:
19+
There are four examples of how to influence and use AI to write documentation in this repository:
2020

21-
- [Custom chat modes](../.github/chatmodes/custom-mode.chatmode.md) — Preset conversational configurations that shape Copilot’s behavior and tone during interactive sessions and document generation.
21+
- [Custom agents](../.github/agents/README.md) — Specialized AI behaviors for tasks like development, testing, and code review. As of October 2025, GitHub renamed "Chat Modes" to "Agents".
22+
- [Custom chat modes](../.github/chatmodes/README.md) *(deprecated)* — Preset conversational configurations that shape Copilot's behavior and tone during interactive sessions and document generation.
2223
- [Instructions](../.github/instructions/docs.instructions.md) — Repository-specific rules and constraints (coding standards, workflow, style) that the AI must follow when producing content.
2324
- [Prompts](../.github/prompts/write-docs.prompt.md) — Reusable prompt templates for generating consistent artifacts (e.g., ADRs, docs, PRDs). See also [write-adr.prompt.md](../.github/prompts/write-adr.prompt.md) and [write-prd.prompt.md](../.github/prompts/write-prd.prompt.md).
2425

plans/TODO.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# TODO list
22

3+
> **Note:** As of October 2025, GitHub renamed "Chat Modes" to "Agents". References to `.github/chatmodes/` and `*.chatmode.md` files in this TODO refer to the deprecated format. The new `.github/agents/` directory uses the `.agent.md` extension. See the migration PR for details.
4+
35
## Repository Improvement TODOs
46

57
Purpose: Track and review each suggested improvement from `recommendations.md` item by item. Use this as the authoritative checklist for implementation and review.

recommendations.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11

22
# Repository Configuration & Content Quality Assessment
33

4-
Scope: Qualitative review of configuration layers (core config, chat modes, instruction files, prompts, planning assets, engineering docs, templates) with redundancy, conflict, risk, and improvement guidance.
4+
> **Note:** As of October 2025, GitHub renamed "Chat Modes" to "Agents". This document was written before that change and references the deprecated `.github/chatmodes/` directory. The new `.github/agents/` directory uses the `.agent.md` extension. Many recommendations in this document have been addressed.
5+
6+
Scope: Qualitative review of configuration layers (core config, chat modes/agents, instruction files, prompts, planning assets, engineering docs, templates) with redundancy, conflict, risk, and improvement guidance.
57

68
Status Legend:
79

0 commit comments

Comments
 (0)