Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Copilot's new customization: Prompt files #7974

Open
digitarald opened this issue Jan 30, 2025 · 0 comments
Open

Document Copilot's new customization: Prompt files #7974

digitarald opened this issue Jan 30, 2025 · 0 comments
Assignees

Comments

@digitarald
Copy link
Contributor

Prompt Files in GitHub Copilot Chat are designed to streamline workflows, enhance collaboration, and bringing domain-specific expertise to developers’ fingertips. With reusable and shareable prompts, developers save time, maintain consistency, and tackle complex tasks with ease. While the existing file-based custom instructions help to add codebase-wide context to each AI workflow, developers add specific prompts as they need them, which makes them scale to the complexity of larger multi-faceted codebases.

Usage:

  • *.prompt.md in .github/prompts
  • reference other files as markdown links or #file:… references
  • Attach to Chat and Edits using the 📎 button, which will also add the linked references.

Use cases:

Streamlining repetitive tasks with reusable prompts.

                  react-hook-form generates a form component with TypeScript types and validation logic tailored to a team’s design system

mock-api-response creates Jest/Mocha tests with mocked API calls, leveraging existing service interfaces

legacy-db-migration generates scripts to refactor outdated SQL schemas into modern ORM models, with inline documentation

Bringing domain-specific expertise to developers on demand, enabling them to tackle complex tasks in specialized areas without requiring deep prior knowledge.

                  hipaa-compliance-check generates code to validate HIPAA-compliant data handling.

                  financial-transaction guidance idempotent API endpoints with audit logging.

                  secure-api guidance for building API endpoints with rate limiting, CORS policies, and input validation.

Also: Enhancing team collaboration and knowledge sharing. Store snippets for frequently used design patterns or architectural guidelines, referencing additional files (e.g., API specs, design docs) for context. Serving as a learning and onboarding tool. Snippets that encapsulate step-by-step explanations for complex processes, project-specific patterns or legacy system quirks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant