Cách cập nhật tệp sức khỏe cộng đồng bằng AI

Đọc Tài liệu để tìm hiểu thêm về các tính năng của GitHub Copilot hoặc bắt đầu ngay hôm nay.

QUERY LENGTH LIMIT EXCEEDED. MAX ALLOWED QUERY : 500 CHARS

** Đề cập đáng chú ý:** tệp * hướng dẫn Copilot * là cấu hình AI bổ sung cho tài liệu sức khỏe. Nó sử dụng các tệp sức khỏe cộng đồng khác làm ngữ cảnh và cho GitHub Copilot biết cách tương tác với cơ sở mã, đảm bảo hỗ trợ nhất quán, chính xác.

Bộ công cụ khởi động: Cách cập nhật các tệp sức khỏe cộng đồng bằng GitHub Copilot

Chúng tôi đã tập hợp một bộ công cụ khởi động bao gồm các phương pháp hay nhất, danh sách kiểm tra toàn diện và hướng dẫn từng bước để thêm ba tệp thiết yếu vào kho lưu trữ của bạn.

Phần 1: Nhắc nhở

Cho dù bạn đang bắt đầu từ đầu hoặc tinh chỉnh tài liệu hiện có, GitHub Copilot có thể giúp bạn viết các tệp sức khỏe cộng đồng rõ ràng hơn, nhất quán hơn chỉ với một vài lời nhắc.

**Mẹo: * * LLM cấp nguồn cho Copilot là không xác định, vì vậy cùng một dấu nhắc có thể tạo ra các đầu ra khác nhau mỗi lần. Kỹ thuật nhanh chóng cải thiện chất lượng, nhưng luôn xác minh đầu ra - đặc biệt là đối với các tệp hợp pháp như GIẤY PHÉP.

## Phần 2: Danh sách kiểm tra

Danh sách kiểm tra này đảm bảo rằng nội dung do Copilot tạo ra là chính xác, toàn diện, an toàn và phù hợp với mục tiêu của dự án.

🔍 Trước khi bạn bắt đầu

Quý vị đã xem xét các hồ sơ y tế cộng đồng hiện có trong các kho lưu trữ tương tự hoặc có liên quan chưa?
Bạn có mục tiêu rõ ràng cho từng thông điệp của tệp (đào tạo nhập môn, kỳ vọng, báo cáo bảo mật) không?
Bạn có quen thuộc với chính sách sử dụng GitHub và hướng dẫn xây dựng thương hiệu của tổ chức mình không?

🧠 Nhắc nhở Copilot một cách hiệu quả

Lời nhắc của bạn có cụ thể và theo ngữ cảnh không? (ví dụ: “Tạo CONTRIBUTING.md cho dự án nguồn mở dựa trên Python với hướng dẫn kiểu mã.”)
Bạn đã bao gồm các tùy chọn về giọng điệu chưa? (ví dụ: "Sử dụng ngôn ngữ hòa nhập và giọng điệu chào đón.")

🛡️ Bảo mật và quyền riêng tư

Tránh nhắc nhở bao gồm thông tin nhạy cảm hoặc độc quyền (thông tin đăng nhập, URL riêng tư).
Xem lại cài đặt hiển thị của kho lưu trữ của bạn (công khai so với riêng tư) và đảm bảo các tệp sức khỏe phù hợp với đối tượng.
Biết cách cài đặt quyền riêng tư của Copilot xử lý các lời nhắc và đề xuất.
'SECURITY.md` của bạn sẽ bao gồm:
- Một phương thức liên lạc rõ ràng để báo cáo các lỗ hổng bảo mật?
- Giải thích ngắn gọn về cách xử lý các vấn đề bảo mật?
- Liên kết đến chính sách tiết lộ có trách nhiệm của bạn?

🧾 **Xem lại đầu ra Copilot **

Nội dung có phản ánh các giá trị và tiêu chuẩn cộng đồng của dự án không?
Có liên kết, tên hoặc chính sách ảo giác nào không tồn tại không?
Tất cả các tài liệu tham khảo bên ngoài có chính xác và cập nhật không?

🧪 Kiểm tra & phản hồi

Có đồng đội hoặc cộng tác viên xem xét các tệp đã tạo không?
Các bước thiết lập kiểm tra trong README.md hoặc CONTRIBUTING.md.
Cởi mở với việc lặp lại dựa trên phản hồi của cộng đồng.

Phần 3: Hướng dẫn

Dưới đây là các bước nhanh chóng, thiết thực để sử dụng Copilot cho ba tệp y tế cộng đồng chính.

📝 Tạo README

Tại sao? README.md rõ ràng giúp người dùng và người đóng góp nhanh chóng hiểu mục đích và cách sử dụng dự án của bạn.

QUERY LENGTH LIMIT EXCEEDED. MAX ALLOWED QUERY : 500 CHARS

📄 Thêm giấy phép

Tại sao? Tệp GIẤY PHÉP bảo vệ cả quyền của bạn và của người dùng, làm rõ cách mã có thể được sử dụng, sửa đổi và phân phối.

Mở GitHub Copilot Chat trong iDE của bạn.
Quyết định giấy phép nào bạn muốn thêm.
Lời nhắc:
"Bạn có thể thêm giấy phép MIT vào dự án của tôi không?"
Copilot sẽ tạo tệp GIẤY PHÉP.
Xem xét tính chính xác của giấy phép (đặc biệt là tên chủ sở hữu bản quyền).
Nhấp vào “Keep” để lưu tệp.
Cam kết `GIẤY PHÉP