Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

create a CONTRIBUTING.md

Đã đóng Phù hợp với người mới
#839 0 bình luận 1 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
76/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

Xem CONTRIBUTING.md của inspect-ai được tham chiếu làm ví dụ, sau đó tạo CONTRIBUTING.md trong repository MathCAT. Bao gồm hướng dẫn về việc thêm các unit test liên quan và giữ cho các thông báo issue và pull request do con người viết hoặc được đánh dấu rõ ràng là bản tóm tắt của AI; công việc hoàn tất khi repository có tệp hướng dẫn contributor mới.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation

While looking through the inspect-ai repo, I saw that they have a CONTRIBUTING.md file which might also make sense for us. From how I understand it, the name is automatically recognized and can be selected easily when looking at the repo, just like README.md

To me, things we might want to put in there are:

  • add relevant unit tests whenever fitting (e.g. fixing a typo in a comment without it is fine)
  • using AI is fine, but issues/PR messages should remain human-written, or have a dedicated block like "AI summary" at the end. The point is that nobody should be forced to read through walls of AI slop.
Ngôn ngữ chính
Rust
Star
121
Fork
90
Merge trung bình
1 ngày 5 giờ
Pull request đã merge (30 ngày)
50

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của daisy/MathCAT

Tất cả issue của daisy/MathCAT

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.