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

Improve docs in Factories

Đang mở Phù hợp với người mới
#161 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 2 ngày

@pollychen-lab đang làm issue này rồi.

Từ ngày 30/9/2026.

  • #162 của @pollychen-lab — đang mở

Đá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
82/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
rust
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu trong tài liệu về các factory của entry point bouncycastle-factory, sau đó so sánh tài liệu về các primitive trong bouncycastle-core::traits. Thêm liên kết từ tài liệu của từng factory đến tài liệu về primitive tương ứng, và xác nhận rằng mọi factory đều cung cấp điều hướng đó cho người dùng IDE.

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

Mô tả

documentation good first issue help wanted

If a user starts with bouncycastle-factory as their entry-point to the library, the docs are rather thin. At a minimum, the docs in each factory should link back to the textbook-y docs about that primitive in bouncycastle-core::traits. This is particularly relevant if a user is using exclusively factories, because those are the docs that they will see in their mouse-over popup in their IDE.

Ngôn ngữ chính
Rust
Star
25
Fork
18
Merge trung bình
14 ngày 10 giờ
Pull request đã merge (30 ngày)
5

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

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 bcgit/bc-rust

Tất cả issue của bcgit/bc-rust

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.