mirror of
https://github.com/github/awesome-copilot.git
synced 2026-02-20 02:15:12 +00:00
2a324116db
- Fix prompt frontmatter: mode: 'agent' → agent: 'agent' (repo convention) - Add applyTo: '**' to instructions file - Remove trailing Claude credit from instructions - Generate plugin via npm run plugin:migrate - Rebase onto latest upstream/main
2.4 KiB
2.4 KiB
description, applyTo
| description | applyTo |
|---|---|
| Guidelines for structuring code and projects to maximize GitHub Copilot effectiveness through better context management | ** |
Context Engineering
Principles for helping GitHub Copilot understand your codebase and provide better suggestions.
Project Structure
- Use descriptive file paths:
src/auth/middleware.ts>src/utils/m.ts. Copilot uses paths to infer intent. - Colocate related code: Keep components, tests, types, and hooks together. One search pattern should find everything related.
- Export public APIs from index files: What's exported is the contract; what's not is internal. This helps Copilot understand boundaries.
Code Patterns
- Prefer explicit types over inference: Type annotations are context.
function getUser(id: string): Promise<User>tells Copilot more thanfunction getUser(id). - Use semantic names:
activeAdultUsers>x. Self-documenting code is AI-readable code. - Define constants:
MAX_RETRY_ATTEMPTS = 3> magic number3. Named values carry meaning.
Working with Copilot
- Keep relevant files open in tabs: Copilot uses open tabs as context signals. Working on auth? Open auth-related files.
- Position cursor intentionally: Copilot prioritizes code near your cursor. Put cursor where context matters.
- Use Copilot Chat for complex tasks: Inline completions have minimal context. Chat mode sees more files.
Context Hints
- Add a COPILOT.md file: Document architecture decisions, patterns, and conventions Copilot should follow.
- Use strategic comments: At the top of complex modules, briefly describe the flow or purpose.
- Reference patterns explicitly: "Follow the same pattern as
src/api/users.ts" gives Copilot a concrete example.
Multi-File Changes
- Describe scope first: Tell Copilot all files involved before asking for changes. "I need to update the User model, API endpoint, and tests."
- Work incrementally: One file at a time, verifying each change. Don't ask for everything at once.
- Check understanding: Ask "What files would you need to see?" before complex refactors.
When Copilot Struggles
- Missing context: Open the relevant files in tabs, or explicitly paste code snippets.
- Stale suggestions: Copilot may not see recent changes. Re-open files or restart the session.
- Generic answers: Be more specific. Add constraints, mention frameworks, reference existing code.