Menyesuaikan respons GitHub Copilot Chat

6 menit

GitHub Copilot Chat dapat menghasilkan respons dan kode yang sesuai dengan praktik pengkodean dan persyaratan proyek Anda saat diberikan konteks yang tepat. Alih-alih berulang kali menambahkan informasi ini di setiap prompt obrolan, Anda dapat menyimpan konteks ini dalam file dan secara otomatis menyertakannya dalam setiap permintaan obrolan.

Ada tiga cara utama untuk menyesuaikan respons AI di Visual Studio Code:

Instruksi kustom: Tentukan panduan umum untuk tugas seperti membuat kode, melakukan tinjauan kode, atau menghasilkan pesan penerapan. Ini menjelaskan bagaimana tugas harus dilakukan dan dapat menentukan praktik pengodean, teknologi pilihan, aturan keamanan, atau format pesan penerapan.
File perintah: Tentukan perintah yang dapat digunakan kembali untuk tugas umum. Perintah mandiri ini menjelaskan apa yang harus dilakukan dan dapat mencakup komponen perancah, melakukan tinjauan kode, membuat panduan langkah demi langkah, atau menghasilkan rencana implementasi.
Mode obrolan kustom: Tentukan bagaimana obrolan beroperasi, alat mana yang dapat digunakannya, dan bagaimana ia berinteraksi dengan basis kode. Contohnya termasuk mode perencanaan dengan akses baca-saja, mode penelitian yang mengakses sumber daya eksternal, atau mode khusus peran seperti pengembangan front-end.

Instruksi khusus

Instruksi kustom memungkinkan Anda menjelaskan panduan yang mendapatkan respons yang cocok dengan praktik pengkodean dan tumpukan teknologi spesifik Anda. Alih-alih menyertakan konteks ini secara manual di setiap kueri obrolan, instruksi kustom secara otomatis menggabungkan informasi ini dengan setiap permintaan obrolan.

Note

Instruksi kustom tidak diperhitungkan untuk penyelesaian kode.

Jenis instruksi kustom

Visual Studio Code mendukung tiga cara untuk menentukan instruksi kustom:

Type	Description	Kasus Penggunaan
`.github/copilot-instructions.md`	File Markdown tunggal di ruang kerja, secara otomatis disertakan dalam semua permintaan, dukungan lintas editor.	Praktik pengkodan umum, teknologi pilihan, persyaratan di seluruh proyek.
`.instructions.md files`	Beberapa file Markdown dengan dukungan pola glob, ruang kerja, atau penyimpanan profil pengguna.	Instruksi khusus tugas, kontrol terperinci saat instruksi berlaku.
Pengaturan Visual Studio Code	Instruksi dalam pengaturan pengguna/ruang kerja untuk skenario tertentu.	Pembuatan kode, pembuatan pengujian, pesan penerapan, ulasan kode, deskripsi PR.

Anda dapat menggabungkan pendekatan ini, tetapi menghindari instruksi yang bertentangan karena tidak ada urutan prioritas yang diterapkan.

Contoh instruksi kustom

Pedoman pengodatan umum:

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

Panduan TypeScript dan 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.

Gunakan file .github/copilot-instructions.md

Simpan instruksi kustom dalam .github/copilot-instructions.md file di akar ruang kerja Anda untuk menjelaskan praktik pengodean, teknologi pilihan, dan persyaratan proyek. Instruksi ini hanya berlaku untuk ruang kerja dan secara otomatis disertakan dalam setiap permintaan obrolan.

Langkah-langkah penyiapan:

Atur github.copilot.chat.codeGeneration.useInstructionFiles ke true.
Buat .github/copilot-instructions.md di akar ruang kerja.
Menjelaskan instruksi menggunakan bahasa alami dan format Markdown.

Note

File ini berfungsi di Visual Studio Code, Visual Studio, dan GitHub.com.

Gunakan file .instructions.md

Buat beberapa .instructions.md file untuk tugas tertentu, bahasa pemrograman, kerangka kerja, atau jenis proyek. Ini dapat diterapkan secara otomatis berdasarkan pola file atau dilampirkan secara manual ke permintaan obrolan.

Lokasi file:

File-file ruang kerja: Disimpan dalam folder .github/instructions, hanya tersedia di ruang kerja.
File pengguna: Disimpan di profil Visual Studio Code, tersedia di beberapa ruang kerja dan disinkronkan melalui Sinkronisasi Pengaturan.

Struktur file:

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

Membuat dan menggunakan file instruksi:

Jalankan Chat: New Instructions File dari Palet Perintah.
Pilih ruang kerja atau lokasi pengguna.
Masukkan petunjuk nama dan penulis di Markdown.
Gunakan Chat: Configure Instructions untuk mengedit file yang ada.

Lampiran petunjuk

Dalam Mode Obrolan: Tambahkan Instruksi Kontekstual >
Palet Perintah: Chat: Attach Instructions

Aplikasi otomatis: Gunakan applyTo metadata dengan pola glob (** untuk semua permintaan, pola khusus untuk aplikasi yang ditargetkan)

Tentukan instruksi kustom dalam pengaturan

Konfigurasikan instruksi kustom di pengaturan Visual Studio Code untuk skenario tertentu:

Scenario	Setting
Pembuatan kode	`github.copilot.chat.codeGeneration.instructions`
Pembuatan pengujian	`github.copilot.chat.testGeneration.instructions`
Ulasan Kode	`github.copilot.chat.reviewSelection.instructions`
Menerapkan pesan	`github.copilot.chat.commitMessageGeneration.instructions`
Judul/deskripsi PR	`github.copilot.chat.pullRequestDescriptionGeneration.instructions`

Tentukan instruksi sebagai teks atau referensi file eksternal:

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

Praktik terbaik untuk instruksi kustom

Tetap ringkas instruksi: Setiap instruksi harus berupa satu pernyataan sederhana.
Hindari referensi eksternal: Jangan merujuk ke standar atau sumber daya pengkodian eksternal.
Atur menurut topik: Pisahkan instruksi menjadi beberapa file untuk organisasi yang lebih baik.
Aktifkan berbagi tim: Simpan instruksi dalam file yang dikontrol versi untuk kolaborasi tim.
Gunakan aplikasi yang ditargetkan: ManfaatkanapplyTo properti untuk instruksi khusus file.
Referensi secara efisien: Mereferensikan instruksi kustom dalam file perintah untuk menghindari duplikasi.

Summary

Instruksi kustom di GitHub Copilot Chat memungkinkan Anda menentukan praktik pengodean, teknologi pilihan, dan persyaratan proyek yang secara otomatis disertakan dalam setiap permintaan obrolan. Dengan menggunakan .github/copilot-instructions.md file, .instructions.md file, atau pengaturan Visual Studio Code, Anda dapat memastikan bahwa respons yang dihasilkan AI selaras dengan standar pengodean dan kebutuhan proyek Anda. Pendekatan ini meningkatkan kualitas dan relevansi bantuan AI sambil mempertahankan kontrol atas proses pengkodean.

Saran dan Komentar

Apakah halaman ini membantu?