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

Add Version Numbers to Library Interfaces

Đang mở
  • Có gì không ổn?
#484 4 bình luận 7 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
javascript
Lĩnh vực
documentation

Hướng nghiên cứu

Issue không xác định tệp, bài kiểm thử hoặc điểm truy cập nào của tài liệu. Trước tiên, hãy kiểm tra cấu trúc của testing-library-docs và tài liệu về interface của nó, sau đó xác định cách biểu diễn metadata phiên bản và các biến thể API trong lịch sử; được xem là hoàn tất khi một phương pháp rõ ràng, có thể duy trì đã được ghi lại và áp dụng nhất quán.

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

Mô tả

enhancement nice to have 😎 organization 📂

Is your feature request related to a problem? Please describe.
I would love to be able to look at each documented interface of a library and learn which version of the library first supported it. The testing library libraries evolve very quickly, and I'd love to learn just by looking at the documentation which version of the library first supported the interface.

As an example, the screen interface shipped at the very end of 2019. I'd like to see what version of the given library supports that API. So if I am using @testing-library/[email protected] I'd want to know if I have access to that feature or not.

Describe the solution you'd like
I'd like to see just a simple mention of what version the feature was first introduced, or alternatively a range of versions the feature supported (perhaps the API mutated between major versions, and you'd like to document the 9.0 - 11.0 behavior, but 12.0 would be different).

Describe alternatives you've considered
As I mentioned above, I see a couple ways this could be implemented. The shorter, simpler, solution would probably be to just list the version it was introduced in. An alternative would be to list the documentation for each permutation an interface undertook, for instance if a method added an argument to its parameters, then both permutations could be listed, perhaps with the deprecated API docs collapsed by default.

There's probably endless room for creativity with this.

Additional context
Thanks for considering it? :)

Ngôn ngữ chính
JavaScript
Star
479
Fork
738
Không có pull request nào được merge trong 30 ngày

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 testing-library/testing-library-docs

Tất cả issue của testing-library/testing-library-docs

Issue tương tự

Thêm issue về JavaScript

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.