Sample Prompts
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
You are my project assistant. I want you to generate a file called `COPILOT_CONTEXT.md` that will act as the single source of truth for project context so you don’t need to read the entire repo each time. This file should help reduce token usage and ensure consistent suggestions. Create `COPILOT_CONTEXT.md` with the following structure: 1. **Project Summary** - 3–5 lines describing what the project does. - Keep it simple but exact. 2. **High-Level Architecture** - List main modules, folders, and how they interact. - Include backend, frontend (if any), DB, vector DB, services, libraries, etc. 3. **Key APIs / Functions** - List only the important functions/classes/endpoints (no full code). - Keep each API to a one-line signature/description. 4. **Coding Conventions** - Language + version (e.g., Python 3.11) - Type-hint rules - PEP8 / formatting instructions - Function/class style guidelines 5. **Important Files & Their Purpose** - Short bullet list (1–2 lines per file) 6. **Data Models / Structures** - Show expected shapes (JSON-like or Python dict examples) - Keep them short and clean 7. **Dev Notes** - How to run, test, install dependencies - Any environment notes (virtualenv, Docker, etc.) 8. **Instructions For Copilot** - Explicitly say: “When generating code, prioritize the information in this file.” - “Use only this file + the currently open buffer for context.” Requirements: - Keep this file concise (not more than a few hundred lines). - No placeholder text — generate meaningful content. - If you need missing information, ask me questions BEFORE generating the file. - After generating the first draft, wait for my review before finalizing. Start by asking me the missing questions you need to build this file. |