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

Insufficient and confusing documentation

Đang mở
#336 0 bình luận 2 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
react, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách xem xét các ví dụ Menu hiện có và tài liệu prop hiện tại. Xác định những phần hướng dẫn sử dụng còn thiếu và các prop chưa rõ ràng, sau đó mở rộng tài liệu bằng các ví dụ và phần giải thích cụ thể. Công việc được xem là hoàn tất khi một người mới có thể hiểu các prop liên quan của Menu và sử dụng component từ các ví dụ.

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

Mô tả

Hi,

This component seems really useful, but the documentation is very scarce and it's making it hard for me to properly use it.

The examples are good but missing pieces, and I'm unsure as to what some of the props for Menu do.

Maybe consider expanding it? It's a suggestion, of course not a demand of any kind.

Ngôn ngữ chính
TypeScript
Star
701
Fork
266
Merge trung bình
1 ngày 2 giờ
Pull request đã merge (30 ngày)
2

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 react-component/menu

Tất cả issue của react-component/menu

Issue tương tự

Thêm issue về TypeScript

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.