Tilpas GitHub Copilot Chat-svar

Fuldført

GitHub Copilot Chat kan generere svar og kode, der matcher din kodningspraksis og projektkrav, når de får den rigtige kontekst. I stedet for gentagne gange at tilføje disse oplysninger i hver chatprompt, kan du gemme denne kontekst i filer og automatisk inkludere den i hver chatanmodning.

Der er tre primære måder at tilpasse AI-svar på i Visual Studio Code:

  • Brugerdefinerede instruktioner: Definer almindelige retningslinjer for opgaver som at generere kode, udføre kodegennemgange eller generere commit-meddelelser. Disse beskriver, hvordan opgaver skal udføres, og kan specificere kodningspraksis, foretrukne teknologier, sikkerhedsregler eller commit-meddelelsesformater.

  • Promptfiler: Definer genanvendelige prompter til almindelige opgaver. Disse selvstændige prompter beskriver, hvad der skal gøres, og kan omfatte stilladskomponenter, udførelse af kodegennemgange, oprettelse af trin-for-trin vejledninger eller generering af implementeringsplaner.

  • Brugerdefinerede chattilstande: Definer, hvordan chat fungerer, hvilke værktøjer den kan bruge, og hvordan den interagerer med kodebasen. Eksempler omfatter planlægningstilstande med skrivebeskyttet adgang, forskningstilstande, der har adgang til eksterne ressourcer, eller rollespecifikke tilstande som frontend-udvikling.

Brugerdefinerede instruktioner

Brugerdefinerede instruktioner giver dig mulighed for at beskrive retningslinjer, der får svar, der matcher din specifikke kodningspraksis og tekniske stak. I stedet for manuelt at inkludere denne kontekst i hver chatforespørgsel, inkorporerer brugerdefinerede instruktioner automatisk disse oplysninger med hver chatanmodning.

Note

Brugerdefinerede instruktioner tages ikke i betragtning ved kodefuldførelser.

Typer af brugerdefinerede instruktioner

Visual Studio Code understøtter tre måder at definere brugerdefinerede instruktioner på:

Type Description Eksempler på brug
.github/copilot-instructions.md Enkelt Markdown-fil i arbejdsområdet, automatisk inkluderet i alle anmodninger, understøttelse på tværs af editorer. Generel kodningspraksis, foretrukne teknologier, krav til hele projektet.
.instructions.md files Flere Markdown-filer med understøttelse af globemønster, arbejdsområde eller brugerprofillagring. Opgavespecifikke instruktioner, detaljeret kontrol over, hvornår instruktioner gælder.
Indstillinger for Visual Studio Code Instruktioner i bruger-/arbejdsområdeindstillinger for specifikke scenarier. Kodegenerering, testgenerering, commit-meddelelser, kodegennemgange, PR-beskrivelser.

Du kan kombinere disse fremgangsmåder, men undgå modstridende instruktioner, da der ikke anvendes nogen prioritetsrækkefølge.

Eksempler på brugerdefinerede instruktioner

Generelle retningslinjer for kodning:

---
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.

TypeScript- og React-retningslinjer:

---
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.

Brug filen .github/copilot-instructions.md

Gem brugerdefinerede instruktioner i en fil i roden .github/copilot-instructions.md af dit arbejdsområde for at beskrive kodningspraksis, foretrukne teknologier og projektkrav. Disse instruktioner gælder kun for arbejdsområdet og inkluderes automatisk i alle chatanmodninger.

Trin til opsætning:

  1. Indstil github.copilot.chat.codeGeneration.useInstructionFiles til true.
  2. Opret .github/copilot-instructions.md i arbejdsområdets rod.
  3. Beskriv instruktioner ved hjælp af naturligt sprog og Markdown-format.

Note

Denne fil fungerer på tværs af Visual Studio Code, Visual Studio og GitHub.com.

Brug .instructions.md-filer

Opret flere .instructions.md filer til specifikke opgaver, programmeringssprog, frameworks eller projekttyper. Disse kan anvendes automatisk baseret på filmønstre eller manuelt vedhæftes chatprompter.

Filplaceringer:

  • Arbejdsområdefiler: Gemt i .github/instructions mappe, kun tilgængelig i arbejdsområdet.
  • Brugerfiler: Gemt i Visual Studio Code-profilen, tilgængelig på tværs af flere arbejdsområder og synkroniseret via Synkronisering af indstillinger.

Filstruktur:

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

Opret og brug instruktionsfiler:

  1. Kør Chat: New Instructions File fra kommandopaletten.
  2. Vælg arbejdsområde eller brugerplacering.
  3. Angiv navn og forfatterinstruktioner i Markdown.
  4. Bruges Chat: Configure Instructions til at redigere eksisterende filer.

Manuel vedhæftning:

  • I chatvisning: Tilføj kontekstinstruktioner >
  • Kommando palet: Chat: Attach Instructions

Automatisk applikation: Brug applyTo metadata med glob-mønstre (** for alle anmodninger, specifikke mønstre for målrettet applikation)

Angiv brugerdefinerede instruktioner i indstillinger

Konfigurer brugerdefinerede instruktioner i Visual Studio Code-indstillinger for bestemte scenarier:

Scenario Setting
Generering af kode github.copilot.chat.codeGeneration.instructions
Generering af test github.copilot.chat.testGeneration.instructions
Gennemgang af kode github.copilot.chat.reviewSelection.instructions
Bekræfte meddelelser github.copilot.chat.commitMessageGeneration.instructions
PR-titler/-beskrivelser github.copilot.chat.pullRequestDescriptionGeneration.instructions

Definer instruktioner som tekst eller referer til eksterne filer:

"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"
  }
]

Bedste praksis for tilpasning af vejledninger

  • Hold instruktionerne kortfattede: Hver instruktion skal være en enkelt, enkel erklæring.
  • Undgå eksterne referencer: Henvis ikke til eksterne kodningsstandarder eller ressourcer.
  • Organiser efter emne: Opdel instruktioner i flere filer for bedre organisering.
  • Aktivér teamdeling: Gem instruktioner i versionsstyrede filer til teamsamarbejde.
  • Brug målrettet program: Udnyt applyTo egenskaben til filspecifikke instruktioner.
  • Referer effektivt: Henvis til brugerdefinerede instruktioner i promptfiler for at undgå duplikering.

Summary

Brugerdefinerede instruktioner i GitHub Copilot Chat giver dig mulighed for at definere kodningspraksis, foretrukne teknologier og projektkrav, der automatisk inkluderes i hver chatanmodning. Ved hjælp af .github/copilot-instructions.md filer, .instructions.md filer eller Visual Studio Code-indstillinger kan du sikre, at AI-genererede svar stemmer overens med dine kodningsstandarder og projektbehov. Denne tilgang forbedrer kvaliteten og relevansen af AI-assistance, samtidig med at kontrollen over kodningsprocessen bevares.