Tùy chỉnh phản hồi GitHub Copilot Chat

Đã hoàn thành

GitHub Copilot Chat có thể tạo phản hồi và mã phù hợp với các phương pháp mã hóa và yêu cầu dự án của bạn khi được cung cấp đúng ngữ cảnh. Thay vì liên tục thêm thông tin này vào mọi lời nhắc trò chuyện, bạn có thể lưu trữ ngữ cảnh này trong tệp và tự động đưa nó vào mọi yêu cầu trò chuyện.

Có ba cách chính để tùy chỉnh phản hồi AI trong Visual Studio Code:

  • Hướng dẫn tùy chỉnh: Xác định các nguyên tắc phổ biến cho các tác vụ như tạo mã, thực hiện đánh giá mã hoặc tạo thông báo cam kết. Chúng mô tả cách thực hiện các tác vụ và có thể chỉ định các phương pháp mã hóa, công nghệ ưa thích, quy tắc bảo mật hoặc định dạng tin nhắn cam kết.

  • Tệp lời nhắc: Xác định lời nhắc có thể tái sử dụng cho các tác vụ thông thường. Các lời nhắc độc lập này mô tả những gì nên làm và có thể bao gồm các thành phần giàn giáo, thực hiện đánh giá mã, tạo hướng dẫn từng bước hoặc tạo kế hoạch triển khai.

  • Chế độ trò chuyện tùy chỉnh: Xác định cách trò chuyện hoạt động, công cụ có thể sử dụng và cách trò chuyện tương tác với cơ sở mã. Ví dụ bao gồm các chế độ lập kế hoạch với quyền truy cập chỉ đọc, các chế độ nghiên cứu truy cập các tài nguyên bên ngoài hoặc các chế độ dành riêng cho vai trò như phát triển giao diện người dùng.

Hướng dẫn tùy chỉnh

Hướng dẫn tùy chỉnh cho phép bạn mô tả các nguyên tắc nhận phản hồi phù hợp với phương pháp mã hóa cụ thể và ngăn xếp công nghệ của bạn. Thay vì đưa ngữ cảnh này vào mọi truy vấn trò chuyện theo cách thủ công, hướng dẫn tùy chỉnh sẽ tự động kết hợp thông tin này với mọi yêu cầu trò chuyện.

Note

Các hướng dẫn tùy chỉnh không được tính đến để hoàn thành mã.

Các loại hướng dẫn tùy chỉnh

Visual Studio Code hỗ trợ ba cách để xác định các hướng dẫn tùy chỉnh:

Type Description Trường hợp sử dụng
.github/copilot-instructions.md Tệp Markdown duy nhất trong không gian làm việc, tự động được đưa vào tất cả các yêu cầu, hỗ trợ biên tập chéo. Thực hành mã hóa chung, công nghệ ưu tiên, yêu cầu toàn dự án.
.instructions.md files Nhiều tệp Markdown với hỗ trợ mẫu glob, không gian làm việc hoặc lưu trữ hồ sơ người dùng. Hướng dẫn theo nhiệm vụ cụ thể, kiểm soát chi tiết thời điểm áp dụng hướng dẫn.
Cài đặt Visual Studio Code Hướng dẫn trong cài đặt người dùng/không gian làm việc cho các tình huống cụ thể. Tạo mã, tạo thử nghiệm, thông báo commit, đánh giá mã, mô tả PR.

Bạn có thể kết hợp các cách tiếp cận này, nhưng tránh các hướng dẫn xung đột vì không có thứ tự ưu tiên nào được áp dụng.

Ví dụ về hướng dẫn tùy chỉnh

Hướng dẫn mã hóa chung:

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

Nguyên tắc TypeScript và 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.

Sử dụng tệp .github/copilot-instructions.md

Lưu trữ hướng dẫn tùy chỉnh trong một tệp .github/copilot-instructions.md ở gốc không gian làm việc của bạn để mô tả các phương pháp mã hóa, công nghệ ưa thích và yêu cầu của dự án. Những hướng dẫn này chỉ áp dụng cho không gian làm việc và được tự động đưa vào mọi yêu cầu trò chuyện.

Các bước thiết lập:

  1. Đặt github.copilot.chat.codeGeneration.useInstructionFiles thành true.
  2. Tạo tại .github/copilot-instructions.md gốc không gian làm việc.
  3. Mô tả hướng dẫn bằng ngôn ngữ tự nhiên và định dạng Markdown.

Note

Tệp này hoạt động trên Visual Studio Code, Visual Studio và GitHub.com.

Sử dụng tệp .instructions.md

Tạo nhiều .instructions.md tệp cho các tác vụ, ngôn ngữ lập trình, khung hoặc loại dự án cụ thể. Chúng có thể được tự động áp dụng dựa trên các mẫu tệp hoặc đính kèm thủ công vào lời nhắc trò chuyện.

Vị trí tệp:

  • Tệp không gian làm việc: Được lưu trữ trong .github/instructions thư mục, chỉ khả dụng trong không gian làm việc.
  • Tệp người dùng: Được lưu trữ trong hồ sơ Visual Studio Code, có sẵn trên nhiều không gian làm việc và được đồng bộ hóa thông qua Đồng bộ hóa cài đặt.

Cấu trúc tệp:

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

Tạo và sử dụng các tệp hướng dẫn:

  1. Chạy từ Chat: New Instructions File Bảng lệnh.
  2. Chọn không gian làm việc hoặc vị trí người dùng.
  3. Nhập hướng dẫn tên và tác giả trong Markdown.
  4. Sử dụng Chat: Configure Instructions để chỉnh sửa các tệp hiện có.

Tệp đính kèm thủ công:

  • Trong chế độ xem Trò chuyện: Thêm hướng dẫn ngữ cảnh >
  • Bảng lệnh: Chat: Attach Instructions

Ứng dụng tự động: Sử dụng siêu applyTo dữ liệu với các mẫu glob (** cho tất cả các yêu cầu, các mẫu cụ thể cho ứng dụng được nhắm mục tiêu)

Chỉ định hướng dẫn tùy chỉnh trong cài đặt

Đặt cấu hình hướng dẫn tùy chỉnh trong cài đặt Visual Studio Code cho các tình huống cụ thể:

Scenario Setting
Tạo mã github.copilot.chat.codeGeneration.instructions
Tạo thử nghiệm github.copilot.chat.testGeneration.instructions
Đánh giá mã github.copilot.chat.reviewSelection.instructions
Thông báo cam kết github.copilot.chat.commitMessageGeneration.instructions
Tiêu đề / mô tả PR github.copilot.chat.pullRequestDescriptionGeneration.instructions

Xác định hướng dẫn dưới dạng văn bản hoặc tham chiếu tệp bên ngoài:

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

Các phương pháp hay nhất cho hướng dẫn tùy chỉnh

  • Giữ hướng dẫn ngắn gọn: Mỗi hướng dẫn phải là một tuyên bố đơn giản, duy nhất.
  • Tránh tham chiếu bên ngoài: Không tham khảo các tiêu chuẩn hoặc tài nguyên mã hóa bên ngoài.
  • Sắp xếp theo chủ đề: Chia hướng dẫn thành nhiều tệp để tổ chức tốt hơn.
  • Cho phép chia sẻ nhóm: Lưu trữ hướng dẫn trong các tệp được kiểm soát phiên bản để cộng tác nhóm.
  • Sử dụng ứng dụng được nhắm mục tiêu: Tận dụng applyTo thuộc tính cho các hướng dẫn cụ thể về tệp.
  • Tham khảo hiệu quả: Tham khảo hướng dẫn tùy chỉnh trong tệp nhắc để tránh trùng lặp.

Summary

Hướng dẫn tùy chỉnh trong GitHub Copilot Chat cho phép bạn xác định các phương pháp mã hóa, công nghệ ưa thích và yêu cầu dự án được tự động đưa vào mọi yêu cầu trò chuyện. Bằng cách sử dụng .github/copilot-instructions.md tệp, .instructions.md tệp hoặc cài đặt Visual Studio Code, bạn có thể đảm bảo rằng các phản hồi do AI tạo phù hợp với các tiêu chuẩn mã hóa và nhu cầu dự án của bạn. Cách tiếp cận này nâng cao chất lượng và mức độ liên quan của hỗ trợ AI trong khi vẫn duy trì quyền kiểm soát quá trình mã hóa.