Add information on documenting directives
Đang mở
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- TypeScript
- Star
- 142
- Fork
- 230
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
We don't currently have any guidelines around documenting elements or directives. Might be something like this:
Documenting directives
To add API documentation to directives, we recommend adding a doc comment on the directive function:
/**
* Renders a placeholder message until `promise` resolves, then renders the
* value of the fulfilled promise.
* @param promise A promise that yields a value to render
*/
export const resolvePromise = directive(ResolvePromise);
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Tìm phần tài liệu phù hợp trong repository lit.dev để hướng dẫn về directive API. Sử dụng nội dung và ví dụ “Documenting directives” được đề xuất làm điểm bắt đầu; hoàn thành có nghĩa là tài liệu hướng dẫn đã được phát hành giải thích các doc comment và tài liệu về tham số cho directives.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- typescript
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 48/100