Skip to content

Commit ee24d7b

Browse files
digitaraldHarald Kirschner
andauthored
init prompt: inventory docs and link instead of duplicating content (#4335)
Co-authored-by: Harald Kirschner <digitarald@gmail.com>
1 parent 752d542 commit ee24d7b

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

assets/prompts/init.prompt.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,12 @@ Bootstrap workspace instructions (`.github/copilot-instructions.md` or `AGENTS.m
2121
- Potential pitfalls or common development environment issues
2222
- Key files/directories that exemplify patterns
2323

24+
Also inventory existing documentation (`docs/**/*.md`, `CONTRIBUTING.md`, `ARCHITECTURE.md`, etc.) to identify topics that should be linked, not duplicated.
25+
2426
3. **Generate or merge**
2527
- New file: Use template from workspace-instructions.md, include only relevant sections
2628
- Existing file: Preserve valuable content, update outdated sections, remove duplication
29+
- Follow the **Link, don't embed** principle from workspace-instructions.md
2730

2831
4. **Iterate**
2932
- Ask for feedback on unclear or incomplete sections

assets/prompts/skills/agent-customization/references/workspace-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ For large repos, link to detailed docs instead of embedding: `See docs/TESTING.m
5555

5656
1. **Minimal by default**: Only what's relevant to *every* task
5757
2. **Concise and actionable**: Every line should guide behavior
58-
3. **Link, don't embed**: Reference docs instead of copying
58+
3. **Link, don't embed**: Reference docs instead of copying content. Search for existing docs (`docs/**/*.md`, `CONTRIBUTING.md`, etc.) and catalog what they cover—only inline agent-critical gotchas not documented elsewhere
5959
4. **Keep current**: Update when practices change
6060

6161
## Anti-patterns

0 commit comments

Comments
 (0)