GitHub Copilot Chat-antwoorden aanpassen

  • 6 minuten

GitHub Copilot Chat kan antwoorden en code genereren die overeenkomen met uw coderingsprocedures en projectvereisten wanneer u de juiste context krijgt. In plaats van deze informatie herhaaldelijk toe te voegen in elke chatprompt, kunt u deze context opslaan in bestanden en deze automatisch opnemen in elke chataanvraag.

Er zijn drie belangrijke manieren om AI-antwoorden aan te passen in Visual Studio Code:

  • Aangepaste instructies: definieer algemene richtlijnen voor taken zoals het genereren van code, het uitvoeren van codebeoordelingen of het genereren van doorvoerberichten. Deze beschrijven hoe taken moeten worden uitgevoerd en kunnen coderingsprocedures, voorkeurstechnologieën, beveiligingsregels of doorvoerberichtindelingen opgeven.

  • Promptbestanden: definieer herbruikbare prompts voor veelvoorkomende taken. Deze zelfstandige prompts beschrijven wat er moet worden gedaan en kunnen onderdelen van de scaffolding bevatten, codebeoordelingen uitvoeren, stapsgewijze handleidingen maken of implementatieplannen genereren.

  • Aangepaste chatmodi: Definieer hoe chatten werkt, welke hulpprogramma's het kan gebruiken en hoe deze communiceert met de codebasis. Voorbeelden hiervan zijn planningsmodi met alleen-lezentoegang, onderzoeksmodi die toegang hebben tot externe resources of rolspecifieke modi, zoals front-endontwikkeling.

Aangepaste instructies

Met aangepaste instructies kunt u richtlijnen beschrijven die antwoorden krijgen die overeenkomen met uw specifieke coderingsprocedures en technische stack. In plaats van deze context handmatig op te nemen in elke chatquery, bevatten aangepaste instructies deze informatie automatisch bij elke chataanvraag.

Note

Aangepaste instructies worden niet meegenomen voor het voltooien van code.

Soorten aangepaste instructies

Visual Studio Code ondersteunt drie manieren om aangepaste instructies te definiëren:

Type Description Gebruiksvoorbeelden
.github/copilot-instructions.md Eén Markdown-bestand in de werkruimte, automatisch opgenomen in alle aanvragen, ondersteuning voor meerdere editors. Algemene coderingsprocedures, voorkeurstechnologieën, projectbrede vereisten.
.instructions.md files Meerdere Markdown-bestanden met glob-patroonondersteuning, werkruimte- of gebruikersprofielopslag. Taakspecifieke instructies, gedetailleerde controle over wanneer instructies van toepassing zijn.
Visual Studio Code-instellingen Instructies in gebruikers-/werkruimte-instellingen voor specifieke scenario's. Code genereren, testen, berichten doorvoeren, codebeoordelingen, PR-beschrijvingen.

U kunt deze benaderingen combineren, maar conflicterende instructies voorkomen omdat er geen prioriteitsvolgorde wordt toegepast.

Voorbeelden van aangepaste instructies

Algemene coderingsrichtlijnen:

---
applyTo: "**"
---
# Project coding standards

## Naming Conventions
- Use PascalCase for component names, interfaces, and type aliases.
- Use camelCase for variables, functions, and methods.
- Prefix private class members with underscore (_).
- Use ALL_CAPS for constants.

## Error Handling
- Use try/catch blocks for async operations.
- Implement proper error boundaries in React components.
- Always log errors with contextual information.

Richtlijnen voor TypeScript en React:

---
applyTo: "**/*.ts,**/*.tsx"
---
# TypeScript and React standards

Apply the [general coding guidelines](./general-coding.instructions.md) to all code.

## TypeScript Guidelines
- Use TypeScript for all new code.
- Follow functional programming principles where possible.
- Use interfaces for data structures and type definitions.
- Prefer immutable data (const, readonly).
- Use optional chaining (?.) and nullish coalescing (??) operators.

## React Guidelines
- Use functional components with hooks.
- Follow the React hooks rules (no conditional hooks).
- Use React.FC type for components with children.
- Keep components small and focused.
- Use CSS modules for component styling.

.github/copilot-instructions.md-bestand gebruiken

Sla aangepaste instructies op in een .github/copilot-instructions.md bestand in de hoofdmap van uw werkruimte om coderingsprocedures, voorkeurstechnologieën en projectvereisten te beschrijven. Deze instructies zijn alleen van toepassing op de werkruimte en worden automatisch opgenomen in elke chataanvraag.

Installatiestappen:

  1. Stel github.copilot.chat.codeGeneration.useInstructionFiles in op true.
  2. Maak .github/copilot-instructions.md in de hoofdmap van de werkruimte.
  3. Beschrijf instructies met natuurlijke taal en Markdown-indeling.

Note

Dit bestand werkt in Visual Studio Code, Visual Studio en GitHub.com.

.instructions.md-bestanden gebruiken

Maak meerdere .instructions.md bestanden voor specifieke taken, programmeertalen, frameworks of projecttypen. Deze kunnen automatisch worden toegepast op basis van bestandspatronen of handmatig zijn gekoppeld aan chatprompts.

Bestandslocaties:

  • Werkruimtebestanden: opgeslagen in .github/instructions map, alleen beschikbaar in de werkruimte.
  • Gebruikersbestanden: opgeslagen in het Visual Studio Code-profiel, beschikbaar in meerdere werkruimten en gesynchroniseerd via Instellingen synchroniseren.

Bestandsstructuur:

---
description: "Brief description of the instructions file"
applyTo: "**/*.ts,**/*.tsx"  # Glob pattern for automatic application
---
# Instructions content in Markdown format

Instructiesbestanden maken en gebruiken:

  1. Voer Chat: New Instructions File uit vanuit het opdrachtpalet.
  2. Kies werkruimte of gebruikerslocatie.
  3. Voer naam- en auteursinstructies in Markdown in.
  4. Gebruik Chat: Configure Instructions deze optie om bestaande bestanden te bewerken.

Handmatige bijlage:

  • In de chatweergave: Contextinstructies > toevoegen
  • Opdrachtenpalet: Chat: Attach Instructions

Automatische toepassing: Metagegevens applyTo gebruiken met glob-patronen (** voor alle aanvragen, specifieke patronen voor de doeltoepassing)

Aangepaste instructies opgeven in instellingen

Aangepaste instructies configureren in Visual Studio Code-instellingen voor specifieke scenario's:

Scenario Setting
Code genereren github.copilot.chat.codeGeneration.instructions
Testgeneratie github.copilot.chat.testGeneration.instructions
Codebeoordeling github.copilot.chat.reviewSelection.instructions
Berichten doorvoeren github.copilot.chat.commitMessageGeneration.instructions
PR-titels en beschrijvingen github.copilot.chat.pullRequestDescriptionGeneration.instructions

Instructies definiëren als tekst of verwijzing naar externe bestanden:

"github.copilot.chat.codeGeneration.instructions": [
  {
    "text": "Always add a comment: 'Generated by Copilot'."
  },
  {
    "text": "In TypeScript always use underscore for private field names."
  },
  {
    "file": "general.instructions.md"
  },
  {
    "file": "db.instructions.md"
  }
]

Aanbevolen procedures voor aangepaste instructies

  • Houd de instructies beknopt: elke instructie moet één eenvoudige instructie zijn.
  • Vermijd externe verwijzingen: verwijst niet naar standaarden of resources voor externe codering.
  • Organiseren op onderwerp: Splits instructies in meerdere bestanden voor een betere organisatie.
  • Team delen inschakelen: Sla instructies op in versiebeheerde bestanden voor teamsamenwerking.
  • Doeltoepassing gebruiken: Gebruik applyTo de eigenschap voor bestandsspecifieke instructies.
  • Efficiënt verwijzen: Verwijs naar aangepaste instructies in promptbestanden om duplicatie te voorkomen.

Summary

Met aangepaste instructies in GitHub Copilot Chat kunt u coderingsprocedures, voorkeurstechnologieën en projectvereisten definiëren die automatisch worden opgenomen in elke chataanvraag. Door bestanden, .github/copilot-instructions.md bestanden of Visual Studio Code-instellingen te gebruiken.instructions.md, kunt u ervoor zorgen dat door AI gegenereerde antwoorden overeenkomen met uw coderingsstandaarden en projectbehoeften. Deze aanpak verbetert de kwaliteit en relevantie van AI-hulp terwijl de controle over het coderingsproces behouden blijft.