Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
141 lines (92 loc) · 7.57 KB

CONTRIBUTING.md

File metadata and controls

141 lines (92 loc) · 7.57 KB
Raw

Đóng góp cho Roo Code

Roo Code là một dự án do cộng đồng điều khiển và chúng tôi vô cùng trân trọng mọi đóng góp. Để hợp lý hóa việc cộng tác, chúng tôi hoạt động trên cơ sở Ưu tiên vấn đề, có nghĩa là tất cả các Yêu cầu kéo (PR) trước tiên phải được liên kết với một Vấn đề trên GitHub. Vui lòng xem kỹ hướng dẫn này.

Bảng mục lục

Trước khi bạn đóng góp

1. Quy tắc ứng xử

Tất cả những người đóng góp phải tuân thủ Quy tắc ứng xử của chúng tôi.

2. Lộ trình dự án

Lộ trình của chúng tôi hướng dẫn định hướng của dự án. Hãy điều chỉnh những đóng góp của bạn với những mục tiêu chính này:

Ưu tiên độ tin cậy

  • Đảm bảo việc chỉnh sửa diff và thực thi lệnh luôn đáng tin cậy.
  • Giảm các điểm ma sát ngăn cản việc sử dụng thường xuyên.
  • Đảm bảo hoạt động trơn tru trên tất cả các ngôn ngữ và nền tảng.
  • Mở rộng hỗ trợ mạnh mẽ cho nhiều nhà cung cấp và mô hình AI.

Trải nghiệm người dùng nâng cao

  • Hợp lý hóa giao diện người dùng/trải nghiệm người dùng để rõ ràng và trực quan.
  • Liên tục cải thiện quy trình làm việc để đáp ứng những kỳ vọng cao của các nhà phát triển đối với các công cụ sử dụng hàng ngày.

Dẫn đầu về hiệu suất tác nhân

  • Thiết lập các tiêu chuẩn đánh giá toàn diện (evals) để đo lường năng suất trong thế giới thực.
  • Giúp mọi người dễ dàng chạy và diễn giải các đánh giá này.
  • Cung cấp các cải tiến cho thấy sự gia tăng rõ ràng về điểm số đánh giá.

Hãy đề cập đến sự phù hợp với các lĩnh vực này trong PR của bạn.

3. Tham gia cộng đồng Roo Code

  • Chính: Tham gia Discord của chúng tôi và nhắn tin trực tiếp cho Hannes Rudolph (hrudolph).
  • Thay thế: Những người đóng góp có kinh nghiệm có thể tham gia trực tiếp qua Dự án GitHub.

Tìm kiếm và lập kế hoạch đóng góp của bạn

Các loại đóng góp

  • Sửa lỗi: giải quyết các vấn đề về mã.
  • Tính năng mới: thêm chức năng.
  • Tài liệu: cải thiện hướng dẫn và sự rõ ràng.

Cách tiếp cận Ưu tiên vấn đề

Tất cả các đóng góp đều bắt đầu bằng một Vấn đề trên GitHub bằng cách sử dụng các mẫu gọn nhẹ của chúng tôi.

  • Kiểm tra các vấn đề hiện có: Tìm kiếm trong Vấn đề trên GitHub.
  • Tạo một vấn đề bằng cách sử dụng:
    • Cải tiến: mẫu "Yêu cầu cải tiến" (ngôn ngữ đơn giản tập trung vào lợi ích của người dùng).
    • Lỗi: mẫu "Báo cáo lỗi" (tái tạo tối thiểu + mong đợi so với thực tế + phiên bản).
  • Bạn muốn làm việc với nó? Bình luận "Nhận" trên vấn đề và nhắn tin trực tiếp cho Hannes Rudolph (hrudolph) trên Discord để được giao. Việc giao nhiệm vụ sẽ được xác nhận trong chuỗi.
  • PR phải liên kết đến vấn đề. Các PR không được liên kết có thể bị đóng.

Quyết định nên làm gì

Báo cáo lỗi

  • Trước tiên hãy kiểm tra các báo cáo hiện có.
  • Tạo một lỗi mới bằng cách sử dụng mẫu "Báo cáo lỗi" với:
    • Các bước tái tạo rõ ràng, được đánh số
    • Kết quả mong đợi so với thực tế
    • Phiên bản Roo Code (bắt buộc); nhà cung cấp/mô hình API nếu có liên quan
  • Vấn đề bảo mật: Báo cáo riêng tư qua tư vấn bảo mật.

Quy trình phát triển và gửi

Thiết lập phát triển

  1. Rẽ nhánh & Sao chép:
git clone https://github.com/TÊN_NGƯỜI_DÙNG_CỦA_BẠN/Roo-Code.git
  1. Cài đặt các phụ thuộc:
pnpm install
  1. Gỡ lỗi: Mở bằng VS Code (F5).

Hướng dẫn viết mã

  • Một PR tập trung cho mỗi tính năng hoặc bản sửa lỗi.
  • Tuân thủ các phương pháp hay nhất của ESLint và TypeScript.
  • Viết các cam kết rõ ràng, mô tả có tham chiếu đến các vấn đề (ví dụ: Sửa lỗi #123).
  • Cung cấp thử nghiệm kỹ lưỡng (npm test).
  • Rebase lên nhánh main mới nhất trước khi gửi.

Gửi yêu cầu kéo

  • Bắt đầu với tư cách là PR nháp nếu bạn đang tìm kiếm phản hồi sớm.
  • Mô tả rõ ràng những thay đổi của bạn theo Mẫu yêu cầu kéo.
  • Liên kết vấn đề trong mô tả/tiêu đề PR (ví dụ: "Sửa lỗi #123").
  • Cung cấp ảnh chụp màn hình/video cho các thay đổi giao diện người dùng.
  • Cho biết nếu cần cập nhật tài liệu.

Chính sách yêu cầu kéo

  • Phải tham chiếu đến một Vấn đề GitHub đã được giao. Để được giao: bình luận "Nhận" trên vấn đề và nhắn tin trực tiếp cho Hannes Rudolph (hrudolph) trên Discord. Việc giao nhiệm vụ sẽ được xác nhận trong chuỗi.
  • Các PR không được liên kết có thể bị đóng.
  • Các PR phải vượt qua các bài kiểm tra CI, phù hợp với lộ trình và có tài liệu rõ ràng.

Quy trình xem xét

  • Phân loại hàng ngày: kiểm tra nhanh bởi những người bảo trì.
  • Xem xét sâu hàng tuần: đánh giá toàn diện.
  • Lặp lại nhanh chóng dựa trên phản hồi.

Pháp lý

Bằng cách đóng góp, bạn đồng ý rằng những đóng góp của bạn sẽ được cấp phép theo Giấy phép Apache 2.0, phù hợp với việc cấp phép của Roo Code.