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
Analyze the specified part of the VS Code Python Extension codebase to generate or update implementation instructions in `.github/instructions/<component>.instructions.md`.
6
+
7
+
## Task
8
+
9
+
Create concise developer guidance focused on:
10
+
11
+
### Implementation Essentials
12
+
13
+
-**Core patterns**: How this component is typically implemented and extended
14
+
-**Key interfaces**: Essential classes, services, and APIs with usage examples
15
+
-**Integration points**: How this component interacts with other extension parts
16
+
-**Common tasks**: Typical development scenarios with step-by-step guidance
17
+
18
+
### Content Structure
19
+
20
+
````markdown
21
+
---
22
+
description: 'Implementation guide for the <component> part of the Python Extension'
23
+
---
24
+
25
+
# <Component> Implementation Guide
26
+
27
+
## Overview
28
+
29
+
Brief description of the component's purpose and role in VS Code Python Extension.
30
+
31
+
## Key Concepts
32
+
33
+
- Main abstractions and their responsibilities
34
+
- Important interfaces and base classes
35
+
36
+
## Common Implementation Patterns
37
+
38
+
### Pattern 1: [Specific Use Case]
39
+
40
+
```typescript
41
+
// Code example showing typical implementation
42
+
```
43
+
````
44
+
45
+
### Pattern 2: [Another Use Case]
46
+
47
+
```typescript
48
+
// Another practical example
49
+
```
50
+
51
+
## Integration Points
52
+
53
+
- How this component connects to other VS Code Python Extension systems
54
+
- Required services and dependencies
55
+
- Extension points and contribution models
56
+
57
+
## Essential APIs
58
+
59
+
- Key methods and interfaces developers need
60
+
- Common parameters and return types
61
+
62
+
## Gotchas and Best Practices
63
+
64
+
- Non-obvious behaviors to watch for
65
+
- Performance considerations
66
+
- Common mistakes to avoid
67
+
68
+
```
69
+
70
+
## Guidelines
71
+
- **Be specific**: Use actual class names, method signatures, and file paths
72
+
- **Show examples**: Include working code snippets from the codebase
73
+
- **Target implementation**: Focus on how to build with/extend this component
74
+
- **Keep it actionable**: Every section should help developers accomplish tasks
75
+
76
+
Source conventions from existing `.github/instructions/*.instructions.md`, `CONTRIBUTING.md`, and codebase patterns.
77
+
78
+
If `.github/instructions/<component>.instructions.md` exists, intelligently merge new insights with existing content.
Analyze the user requested part of the codebase (use a suitable <placeholder>) to generate or update `.github/instructions/<placeholder>.instructions.md` for guiding developers and AI coding agents.
6
+
7
+
Focus on practical usage patterns and essential knowledge:
8
+
9
+
- How to use, extend, or integrate with this code area
10
+
- Key architectural patterns and conventions specific to this area
11
+
- Common implementation patterns with code examples
12
+
- Integration points and typical interaction patterns with other components
13
+
- Essential gotchas and non-obvious behaviors
14
+
15
+
Source existing conventions from `.github/instructions/*.instructions.md`, `CONTRIBUTING.md`, and `README.md`.
16
+
17
+
Guidelines:
18
+
19
+
- Write concise, actionable instructions using markdown structure
20
+
- Document discoverable patterns with concrete examples
21
+
- If `.github/instructions/<placeholder>.instructions.md` exists, merge intelligently
22
+
- Target developers who need to work with or extend this code area
23
+
24
+
Update `.github/instructions/<placeholder>.instructions.md` with header:
25
+
26
+
```
27
+
---
28
+
description: "How to work with the <placeholder> part of the codebase"
0 commit comments