Viết chỉ dẫn Copilot hữu ích cho repository | DevPrompt Lab

Giữ `.github/copilot-instructions.md` ngắn gọn, chính xác và sát với mã nguồn.

rule · AI tooling · beginner

English Tiếng Việt

Hướng dẫn soạn chỉ dẫn Copilot cấp repository với lệnh đã xác minh và quy ước ảnh hưởng tới sinh mã.

Nội dung có thể tái sử dụng

Viết `.github/copilot-instructions.md` bằng Markdown ngắn gọn, mô tả kiến trúc repository, quy ước quan trọng, ranh giới triển khai an toàn và lệnh kiểm tra đã xác minh. Nêu thư mục nào chịu trách nhiệm cho từng phần. Giải thích tệp được tạo tự động hoặc ràng buộc tương thích cần giữ. Tránh bí mật, sở thích mơ hồ và chỉ dẫn xung đột tài liệu tại chỗ. Giữ ví dụ mã hiện hành và ngắn.

Stack và kiến trúc: {{STACK}}

Lệnh build và kiểm thử đã xác minh: {{TEST_COMMANDS}}

Quy ước viết mã: {{STYLE}}

Cách sử dụng

Kiểm tra hành vi instruction file hiện tại của GitHub và repository có tệp chỉ dẫn riêng theo đường dẫn hay không.

Ví dụ

Với thay đổi backend, giữ cấu trúc JSON response và kiểm tra owner scope trong SQL. Chạy `php -l` trên các tệp đã đổi.