Skip to content

Commit bb6670e

Browse files
authored
Remove AGENTS.md and associated references. (#8)
1 parent ef24fed commit bb6670e

File tree

8 files changed

+28
-46
lines changed

8 files changed

+28
-46
lines changed

.github/README.github.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ Key SSOT anchors:
2929

3030
See also:
3131
- Project overview in [README.md](../README.md)
32-
- Agent context in [AGENTS.md](../AGENTS.md)
3332

3433
### Custom Chat Modes
3534

.github/copilot-instructions.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,18 @@ This creates a self-documenting system for understanding how AI instructions wor
4242
==============================================================================
4343
-->
4444

45+
**CRITICAL REQUIREMENTS**
46+
- AI assistants must _never_ remove HTML comments explaining the purpose and design of each section.
47+
- HTML comments provide essential context for understanding the instructional design and MUST remain intact.
48+
49+
<CRIITICAL_REQUIREMENT type="MANDATORY">
50+
<HTML_COMMENT presence="REQUIRED">
51+
AUDIENCE: Primarily humans, but applicable to all AI coding assistants
52+
DESIGN PHILOSOPHY: Maximum clarity and comprehensiveness through clear explanations
53+
PURPOSE: Explain the instructional design, reinforcement techniques, and compliance mechanisms used in this section
54+
</HTML_COMMENT>
55+
</CRITICAL_REQUIREMENT>
56+
4557
**Audience:** Primarily GitHub Copilot. This file provides Copilot-specific instructions and configuration for this repository.
4658

4759
**Repository Context:**
@@ -50,7 +62,6 @@ This repository is a GitHub Template created by Capgemini's AI & Software Engine
5062
**Copilot Guidance:**
5163
- Follow the configuration and best practices outlined here when assisting in this repository.
5264
- Reference `README.md` for general orientation and project goals.
53-
- Reference `AGENTS.md` for broader AI agent instructions and context.
5465

5566
<!--
5667
==============================================================================

.github/instructions/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Bad: # Architecture
8080
## Best practices
8181

8282
- Keep instruction files focused (single responsibility). Prefer multiple small files over one large file.
83-
- Cross-reference `AGENTS.md` and `.github/copilot-instructions.md` for repository-wide policies.
83+
- Cross-reference `.github/copilot-instructions.md` for repository-wide policies.
8484
- Use examples liberally — AI systems map rules to examples well.
8585

8686
## Official docs

.github/prompts/copilot-setup-check.prompt.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ Perform a comprehensive evaluation of the repository's GitHub Copilot and AI age
1313
## Evaluation Scope
1414

1515
This evaluation will assess:
16-
- **AGENTS.md** - General AI agent instructions and repository context
1716
- **.github/copilot-instructions.md** - Copilot-specific configuration and guidelines
1817
- **.github/chatmodes/** - Custom conversational behaviors and specialized modes
1918
- **.github/prompts/** - Reusable prompt templates and slash commands
@@ -41,18 +40,23 @@ This evaluation will assess:
4140

4241
### Phase 1: Core Files Assessment
4342

44-
1. **Check AGENTS.md existence and quality**
43+
1. **For each file type, check existence and quality**
4544
- Verify presence and structure
4645
- Assess clarity of repository context
4746
- Evaluate AI agent guidance completeness
4847
- Check for conflicting instructions warning mechanisms
48+
- Verify effectiveness of XML semantic tags reinforcing critical requirements
49+
- Suggest improvements for clarity and completeness
50+
- Suggest enhancements for maintainability and organization
51+
- Suggest additions for missing best practices
52+
- Suggest removal of redundant or conflicting content
53+
- Suggest reinforcements (e.g. XML, Mermaid) for critical policies
4954

5055
2. **Evaluate .github/copilot-instructions.md**
5156
- Verify comprehensive project methodology coverage
5257
- Assess branching strategy and workflow definitions
5358
- Check commit message and naming conventions
54-
- Evaluate coding standards and quality requirements
55-
- Verify XML semantic tags for critical requirements
59+
- Evaluate generic coding standards and quality requirements
5660

5761
### Phase 2: Advanced Configuration Review
5862

@@ -61,18 +65,23 @@ This evaluation will assess:
6165
- Assess relevance to project needs
6266
- Check for mode-specific optimization
6367
- Evaluate documentation quality
68+
- Evaluate conflicts with core instructions, custom instructions (per file type), or custom prompts
6469

6570
4. **Review prompt templates**
6671
- Inventory available slash commands
6772
- Assess prompt structure and parameterization
6873
- Check tool integration and capability coverage
6974
- Evaluate reusability and maintenance
75+
- Evaluate conflicts with core instructions, custom instructions (per file type), or custom chatmodes
7076

7177
5. **Examine instruction files**
7278
- Catalog language/domain-specific instructions
73-
- Assess coverage of technology stack
79+
- Assess coverage of technology stack and frameworks
80+
- Evaluate clarity and actionability of language/framework specific instructions
7481
- Check alignment with project requirements
7582
- Evaluate specificity and actionability
83+
- Evaluate specific coding standards and quality requirements
84+
- Evaluate conflicts with core instructions, custom chatmodes, or custom prompts
7685

7786
### Phase 3: Integration and Optimization
7887
6. **Repository structure alignment**

AGENTS.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,6 @@ When adding new chat modes, prompts, or instructions:
141141

142142
## Where to find more information
143143

144-
- See `AGENTS.md` for general AI agent instructions and project context
145144
- See `.github/copilot-instructions.md` for Copilot-specific rules and configuration
146145
- See `CONTRIBUTING.md` for guidelines on contributing to this repository
147146

@@ -160,7 +159,6 @@ flowchart LR
160159
%% Core Configuration Hub (Left)
161160
subgraph CONFIG ["🏠 Core Configuration"]
162161
CI["copilot-instructions.md"]
163-
AGENTS["AGENTS.md"]
164162
README["README.md"]
165163
end
166164
@@ -261,7 +259,6 @@ flowchart LR
261259
### Central Configuration Hub
262260

263261
- `.github/copilot-instructions.md` serves as the primary configuration document, referencing most instruction files and core documentation
264-
- `AGENTS.md` provides repository-wide context and references key directories and processes
265262

266263
### Documentation Workflow
267264

plans/TODO.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ How to use:
2626
| P1-09 | Small Plan Example | Add lightweight “Small Feature Plan” example | `plans/examples/plan-small.md` (new) | New example file added; linked from `plans/README.md` | High | AI | Done | Added example aligned to complexity-only; linked from plans README |
2727
| P1-10 | SSOT Source Map | Add “Source Map” appendix to README linking SSOT designations | `README.md` | Appendix added with links mapping domains to SSOT files | High | AI | Done | Added Appendix: SSOT Source Map with links to core policies and anchors |
2828
| P2-11 | GitHub README Consolidation | Fold `.github/README.github.md` into root `README.md` or leave stub | `.github/README.github.md`; `README.md` | Duplicated sections removed; unique GitHub-specific notes retained/merged; stub or removal justified | Medium | AI | Done | Kept distinct .github README, pruned duplication, added SSOT links and pointers to root |
29-
| P2-12 | Agents Landing | Keep `AGENTS.md` minimal; add explicit pointer to copilot-instructions | `AGENTS.md` | Line added: authoritative workflow rules in `.github/copilot-instructions.md` | Medium | AI | Done | Added explicit pointer to SSOT rules and note to keep file minimal |
29+
| P2-12 | Agents generic file | Remove `AGENTS.md` | `AGENTS.md` | Line added: authoritative workflow rules in `.github/copilot-instructions.md` | Medium | AI | Done | Added explicit pointer to SSOT rules and note to keep file minimal |
3030
| P2-13 | Chat Modes SSOT | Declare chat modes authoring SSOT and avoid meta duplication | `.github/chatmodes/README.md`; all `*.chatmode.md` | README declares SSOT; each chat mode avoids restating meta-guidelines | Medium | AI | Done | Added SSOT section to chatmodes README; inserted SSOT reference notes in all modes |
3131
| P2-14 | Frontend Testing Reference | Explicitly reference testing standards | `.github/instructions/frontend.instructions.md` | Adds “Testing” subsection that links to Tester chat mode and BDD instructions | Medium | AI | Done | Added Testing section with links to Tester chat mode, BDD SSOT, and Quality Policy |
3232
| P2-15 | ADR Save Validation | Ensure ADR prompt enforces save path/versioning | `.github/prompts/write-adr.prompt.md`; `docs/ADRs/adr-template.md` | Prompt validates save under `docs/ADRs/` with sequence/timestamp; ADR template includes Status field | Medium | AI | Done | Prompt updated with sequence/timestamp rules, save validation, and commit guidance; template already has Status |

recommendations.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ Status Legend:
1717
| File | Assessment | Issues / Risks | Recommendation |
1818
| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1919
| [.github/copilot-instructions.md](.github/copilot-instructions.md) | Comprehensive anchor (branching, commits, standards, repo overview). Strong reinforcement (XML, Mermaid). | Duplicates coverage & workflow rules already present in chat modes. Repository overview partially overlaps with [README.md](README.md) and [.github/README.github.md](.github/README.github.md). | Refine: Trim “Repository Overview” (point to README). Establish it as single source of truth (SSOT) for: branching, commit, PR workflow, global quality gates. |
20-
| [AGENTS.md](AGENTS.md) | Lightweight cross‑entry overview for all AI agents. | Some repetition (structure, docs locations) already covered in [README.md](README.md). | Keep: Leave as minimal orientation. Add explicit statement: “For authoritative workflow rules see .github/copilot-instructions.md”. |
2120
| [README.md](README.md) | Broad narrative, feature catalog, diagrams, best practices. | Overlaps with `.github/copilot-instructions.md` (methodology summaries) and `.github/chatmodes/README.md` (instruction philosophy). | Refine: Move “Best Practices” enforcement rules to a new “CONTRIBUTING.md” or keep here but reference as non-authoritative. |
2221
| [.github/README.github.md](.github/README.github.md) | GitHub config explainer; bridges discoverability. | Partial duplication of README sections (chat modes, instructions explanation). | Consolidate: Fold unique GitHub-specific notes into README; leave a short index stub or remove. |
2322

@@ -175,7 +174,6 @@ Principles:
175174
| File | Status |
176175
| ----------------------------------------------- | ----------- |
177176
| .github/copilot-instructions.md | Refine |
178-
| AGENTS.md | Keep |
179177
| README.md | Refine |
180178
| .github/README.github.md | Consolidate |
181179
| Developer.chatmode.md | Refine |

0 commit comments

Comments
 (0)