Skip to content

Commit 3393f5d

Browse files
DOC: Restore prompt file references in copilot-instructions.md
The .github/prompts/ directory contains setup-dev-env, build-ddbc, run-tests, and create-pr prompt files. Previous commit incorrectly removed references to them. Restore the workflow table and debug quick reference links.
1 parent 3773e92 commit 3393f5d

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

.github/copilot-instructions.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,21 @@
1212

1313
## Development Workflows
1414

15+
This repository includes detailed prompt files for common tasks. Reference these with `#`:
16+
17+
| Task | Prompt | When to Use |
18+
|------|--------|-------------|
19+
| First-time setup | `#setup-dev-env` | New machine, fresh clone |
20+
| Build C++ extension | `#build-ddbc` | After modifying .cpp/.h files |
21+
| Run tests | `#run-tests` | Validating changes |
22+
| Create PR | `#create-pr` | Ready to submit changes |
23+
1524
**Workflow order for new contributors:**
16-
1. Create and activate a virtual environment (`python -m venv .venv`)
17-
2. Install dependencies (`pip install -r requirements.txt`)
18-
3. Build the native extension (see Build System below)
19-
4. Make your changes
20-
5. Run tests (`python -m pytest -v`)
21-
6. Submit a PR
25+
1. `#setup-dev-env` — Set up venv and dependencies
26+
2. `#build-ddbc` — Build native extension
27+
3. Make your changes
28+
4. `#run-tests` — Validate
29+
5. `#create-pr` — Submit
2230

2331
## Build System and Validation
2432

@@ -234,11 +242,11 @@ Exception (base)
234242

235243
| Error | Cause | Solution |
236244
|-------|-------|----------|
237-
| `ImportError: ddbc_bindings` | Extension not built | Build native extension (see Build System) |
245+
| `ImportError: ddbc_bindings` | Extension not built | Run `#build-ddbc` |
238246
| Connection timeout | Missing env var | Set `DB_CONNECTION_STRING` |
239247
| `dylib not found` (macOS) | Library paths | Run `configure_dylibs.sh` |
240248
| `ODBC Driver not found` | Missing driver | Install Microsoft ODBC Driver 18 |
241-
| `ModuleNotFoundError` | Not in venv | Activate virtual environment |
249+
| `ModuleNotFoundError` | Not in venv | Run `#setup-dev-env` |
242250

243251
## Contributing Guidelines
244252

0 commit comments

Comments
 (0)