Mukauta GitHub Copilot Chat -vastauksia

6 minuuttia

GitHub Copilot Chat voi luoda vastauksia ja koodia, jotka vastaavat koodauskäytäntöjäsi ja projektin vaatimuksia, kun se annetaan oikeassa kontekstissa. Sen sijaan, että lisäisit nämä tiedot toistuvasti jokaiseen keskustelukehotteeseen, voit tallentaa tämän kontekstin tiedostoihin ja sisällyttää ne automaattisesti jokaiseen keskustelupyyntöön.

Visual Studio Codessa on kolme päätapaa mukauttaa tekoälyvastauksia:

Mukautetut ohjeet: Määritä yleiset ohjeet tehtäville, kuten koodin luomiselle, koodin tarkistusten suorittamiselle tai toimitusviestien luomiselle. Niissä kuvataan, miten tehtävät tulisi suorittaa, ja niissä voidaan määritellä koodauskäytännöt, suositeltavat tekniikat, suojaussäännöt tai toimitusviestien muodot.
Kehotetiedostot: Määritä uudelleenkäytettävät kehotteet yleisille tehtäville. Nämä erilliset kehotteet kuvaavat, mitä tulisi tehdä, ja ne voivat sisältää telinekomponentteja, koodin tarkistusten suorittamista, vaiheittaisten oppaiden luomista tai toteutussuunnitelmien luomista.
Mukautetut chat-tilat: Määritä, miten chat toimii, mitä työkaluja se voi käyttää ja miten se on vuorovaikutuksessa koodikannan kanssa. Esimerkkejä ovat suunnittelutilat, joissa on vain luku -käyttöoikeus, tutkimustilat, jotka käyttävät ulkoisia resursseja, tai roolikohtaiset tilat, kuten edustakehitys.

Mukautetut ohjeet

Mukautettujen ohjeiden avulla voit kuvata ohjeita, jotka saavat vastauksia, jotka vastaavat koodauskäytäntöjäsi ja teknistä pinoasi. Sen sijaan, että tämä konteksti sisällytettäisiin manuaalisesti jokaiseen keskustelukyselyyn, mukautetut ohjeet sisällyttävät nämä tiedot automaattisesti jokaiseen keskustelupyyntöön.

Note

Mukautettuja ohjeita ei oteta huomioon koodin täydennyksessä.

Mukautettujen ohjeiden tyypit

Visual Studio Code tukee kolmea tapaa määrittää mukautettuja ohjeita:

Type	Description	Käyttötapaukset
`.github/copilot-instructions.md`	Yksi Markdown-tiedosto työtilassa, sisällytetään automaattisesti kaikkiin pyyntöihin, editorien välinen tuki.	Yleiset koodauskäytännöt, suositeltavat tekniikat, projektin laajuiset vaatimukset.
`.instructions.md files`	Useita Markdown-tiedostoja glob-kuvion tuella, työtilan tai käyttäjäprofiilin tallennustilalla.	Tehtäväkohtaiset ohjeet, yksityiskohtainen hallinta siitä, milloin ohjeita sovelletaan.
Visual Studio Coden asetukset	Ohjeet käyttäjän/työtilan asetuksissa tiettyjä skenaarioita varten.	Koodin luominen, testien luominen, toimitusviestit, kooditarkistukset, PR-kuvaukset.

Voit yhdistää nämä lähestymistavat, mutta välttää ristiriitaisia ohjeita, koska prioriteettijärjestystä ei käytetä.

Esimerkkejä mukautetuista ohjeista

Yleiset koodausohjeet:

---
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- ja React-ohjeet:

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

Käytä .github/copilot-instructions.md-tiedostoa

Tallenna mukautetut ohjeet .github/copilot-instructions.md työtilan pääkansioon tiedostoon, jossa kuvataan koodauskäytäntöjä, ensisijaisia tekniikoita ja projektivaatimuksia. Nämä ohjeet koskevat vain työtilaa, ja ne sisällytetään automaattisesti jokaiseen chat-pyyntöön.

Asennuksen vaiheet:

Määritä github.copilot.chat.codeGeneration.useInstructionFiles -arvoksi true.
Luo .github/copilot-instructions.md työtilan pääkäyttäjänä.
Kuvaile ohjeet luonnollisella kielellä ja Markdown-muodossa.

Note

Tämä tiedosto toimii Visual Studio Codessa, Visual Studiossa ja GitHub.com.

Käytä .instructions.md-tiedostoja

Luo useita .instructions.md tiedostoja tietyille tehtäville, ohjelmointikielille, kehyksille tai projektityypeille. Näitä voidaan käyttää automaattisesti tiedostomallien perusteella tai liittää manuaalisesti chat-kehotteisiin.

Tiedostojen sijainnit:

Työtilan tiedostot: Tallennetaan kansioon .github/instructions , käytettävissä vain työtilassa.
Käyttäjätiedostot: Tallennetaan Visual Studio Code -profiiliin, käytettävissä useissa työtiloissa ja synkronoidaan asetusten synkronoinnin kautta.

Tiedoston rakenne:

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

Luo ja käytä ohjetiedostoja:

Suorita Chat: New Instructions File komentopaletista.
Valitse työtila tai käyttäjän sijainti.
Kirjoita nimi ja tekijän ohjeet Markdowniin.
Käytä Chat: Configure Instructions olemassa olevien tiedostojen muokkaamiseen.

Manuaalinen kiinnitys:

Chat-näkymässä: Lisää kontekstiohjeita >
Komentopaletti: Chat: Attach Instructions

Automaattinen sovellus: Käytä applyTo metatietoja glob-kuvioiden kanssa (** kaikille pyynnöille, tietyt mallit kohdennetulle sovellukselle)

Mukautettujen ohjeiden määrittäminen asetuksissa

Määritä mukautetut ohjeet Visual Studio Code -asetuksissa tietyissä skenaarioissa:

Scenario	Setting
Koodin luominen	`github.copilot.chat.codeGeneration.instructions`
Testin sukupolvi	`github.copilot.chat.testGeneration.instructions`
Koodin tarkistus	`github.copilot.chat.reviewSelection.instructions`
Viestien toimittaminen	`github.copilot.chat.commitMessageGeneration.instructions`
PR-otsikot/kuvaukset	`github.copilot.chat.pullRequestDescriptionGeneration.instructions`

Määritä ohjeet tekstinä tai viittaavat ulkoisiin tiedostoihin:

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

Mukautettujen ohjeiden parhaat käytännöt

Pidä ohjeet ytimekkäinä: Jokaisen ohjeen tulee olla yksi, yksinkertainen lause.
Vältä ulkoisia viittauksia: Älä viittaa ulkoisiin koodausstandardeihin tai resursseihin.
Järjestä aiheen mukaan: Jaa ohjeet useisiin tiedostoihin organisoinnin parantamiseksi.
Ota tiimin jakaminen käyttöön: Tallenna ohjeet versioohjattuihin tiedostoihin tiimiyhteistyötä varten.
Käytä kohdennettua sovellusta: Hyödynnä applyTo tiedostokohtaisten ohjeiden ominaisuutta.
Viittaa tehokkaasti: Viittaa mukautettuihin ohjeisiin kehotetiedostoissa päällekkäisyyksien välttämiseksi.

Summary

GitHub Copilot Chatin mukautettujen ohjeiden avulla voit määrittää koodauskäytännöt, ensisijaiset tekniikat ja projektivaatimukset, jotka sisällytetään automaattisesti jokaiseen chat-pyyntöön. Käyttämällä .github/copilot-instructions.md tiedostoja, .instructions.md tiedostoja tai Visual Studio Code -asetuksia voit varmistaa, että tekoälyn luomat vastaukset vastaavat koodausstandardejasi ja projektitarpeitasi. Tämä lähestymistapa parantaa tekoälyavun laatua ja merkityksellisyyttä säilyttäen samalla koodausprosessin hallinnan.

Palaute

Onko tästä sivusta apua?