docsifyjs / docsifyjs/docsify

[Plugins] : Independent Test Solution for plugins

Đang mở
#1,021 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
help wanted pinned
Ngôn ngữ chính
JavaScript
Star
31.5k
Fork
5.8k
Merge trung bình
9 ngày 8 giờ
Pull request đã merge (30 ngày)
2

Mô tả

This is more like a way or solution request for plugins to independently tests with docsify.
Currently, the official plugins and most of the third-party plugins (all of them which I saw) don't have test for their plugins. Unit testing for the logic method of a plugin can be done seamlessly but for integration testing with docsify core, it's quite tough from my end.

This is required as in future release there can be some changes in the core regarding the compiler part or the hooks part or any other changes. And it is to ensure that plugins don't break.

This issue is to document the testing guide for the plugins independently. As I am not so good with testing this deep I can't document that myself.

You can either submit a PR in this repo regarding updating the docs about testing the plugins.
Before submitting PR, it would be nice to have a comment here about your approach and also to have a demo by either testing any plugins from this repo or any other plugin.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Issue không nêu tên tệp tài liệu, lệnh kiểm thử hoặc điểm vào của plugin. Hãy bắt đầu bằng việc xem xét cách trình biên dịch core của docsify và các hook tương tác với một plugin hiện có, sau đó viết tài liệu hướng dẫn có thể tái lập cho việc kiểm thử tích hợp độc lập và minh họa bằng một plugin. Công việc được xem là hoàn tất khi hướng dẫn giải thích cách phát hiện plugin bị hỏng sau các thay đổi trong core.

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

Đánh giá

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

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.