Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions .github/prompts/extract-impl-instructions.prompt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
mode: edit
---

Analyze the specified part of the VS Code Python Extension codebase to generate or update implementation instructions in `.github/instructions/<component>.instructions.md`.

## Task

Create concise developer guidance focused on:

### Implementation Essentials

- **Core patterns**: How this component is typically implemented and extended
- **Key interfaces**: Essential classes, services, and APIs with usage examples
- **Integration points**: How this component interacts with other extension parts
- **Common tasks**: Typical development scenarios with step-by-step guidance

### Content Structure

````markdown
---
description: 'Implementation guide for the <component> part of the Python Extension'
---

# <Component> Implementation Guide

## Overview

Brief description of the component's purpose and role in VS Code Python Extension.

## Key Concepts

- Main abstractions and their responsibilities
- Important interfaces and base classes

## Common Implementation Patterns

### Pattern 1: [Specific Use Case]

```typescript
// Code example showing typical implementation
```
````

### Pattern 2: [Another Use Case]

```typescript
// Another practical example
```

## Integration Points

- How this component connects to other VS Code Python Extension systems
- Required services and dependencies
- Extension points and contribution models

## Essential APIs

- Key methods and interfaces developers need
- Common parameters and return types

## Gotchas and Best Practices

- Non-obvious behaviors to watch for
- Performance considerations
- Common mistakes to avoid

```

## Guidelines
- **Be specific**: Use actual class names, method signatures, and file paths
- **Show examples**: Include working code snippets from the codebase
- **Target implementation**: Focus on how to build with/extend this component
- **Keep it actionable**: Every section should help developers accomplish tasks

Source conventions from existing `.github/instructions/*.instructions.md`, `CONTRIBUTING.md`, and codebase patterns.

If `.github/instructions/<component>.instructions.md` exists, intelligently merge new insights with existing content.
```
30 changes: 30 additions & 0 deletions .github/prompts/extract-usage-instructions.prompt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
mode: edit
---

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.

Focus on practical usage patterns and essential knowledge:

- How to use, extend, or integrate with this code area
- Key architectural patterns and conventions specific to this area
- Common implementation patterns with code examples
- Integration points and typical interaction patterns with other components
- Essential gotchas and non-obvious behaviors

Source existing conventions from `.github/instructions/*.instructions.md`, `CONTRIBUTING.md`, and `README.md`.

Guidelines:

- Write concise, actionable instructions using markdown structure
- Document discoverable patterns with concrete examples
- If `.github/instructions/<placeholder>.instructions.md` exists, merge intelligently
- Target developers who need to work with or extend this code area

Update `.github/instructions/<placeholder>.instructions.md` with header:

```
---
description: "How to work with the <placeholder> part of the codebase"
---
```
Loading