mirror of
https://github.com/microsoft/vscode.git
synced 2026-05-23 00:29:35 +01:00
init prompt: inventory docs and link instead of duplicating content (#4335)
Co-authored-by: Harald Kirschner <digitarald@gmail.com>
This commit is contained in:
@@ -21,9 +21,12 @@ Bootstrap workspace instructions (`.github/copilot-instructions.md` or `AGENTS.m
|
||||
- Potential pitfalls or common development environment issues
|
||||
- Key files/directories that exemplify patterns
|
||||
|
||||
Also inventory existing documentation (`docs/**/*.md`, `CONTRIBUTING.md`, `ARCHITECTURE.md`, etc.) to identify topics that should be linked, not duplicated.
|
||||
|
||||
3. **Generate or merge**
|
||||
- New file: Use template from workspace-instructions.md, include only relevant sections
|
||||
- Existing file: Preserve valuable content, update outdated sections, remove duplication
|
||||
- Follow the **Link, don't embed** principle from workspace-instructions.md
|
||||
|
||||
4. **Iterate**
|
||||
- Ask for feedback on unclear or incomplete sections
|
||||
|
||||
+1
-1
@@ -55,7 +55,7 @@ For large repos, link to detailed docs instead of embedding: `See docs/TESTING.m
|
||||
|
||||
1. **Minimal by default**: Only what's relevant to *every* task
|
||||
2. **Concise and actionable**: Every line should guide behavior
|
||||
3. **Link, don't embed**: Reference docs instead of copying
|
||||
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
|
||||
4. **Keep current**: Update when practices change
|
||||
|
||||
## Anti-patterns
|
||||
|
||||
Reference in New Issue
Block a user