bytecodealliance / bytecodealliance/component-docs

Define markdown convention/formatting rules

Đang mở
#292 3 bình luận 0 reaction 0 người được giao Xem trên GitHub
enhancement quality tooling
Ngôn ngữ chính
Rust
Star
137
Fork
88
Merge trung bình
5 ngày 12 giờ
Pull request đã merge (30 ngày)
4

Mô tả

It would be good to define our standards/expectations for markdown formatting somewhere consistently.

A good place for this would be `CONTRIBUTING.md`, but other places could work too.

In addition to introducing documentation on how markdown should be written in the repo, we should probably try and
implement some tooling that enables machines to check our output for us:

- https://github.com/hukkin/mdformat
- https://github.com/DavidAnson/markdownlint
- https://dprint.dev/overview/ w/ https://github.com/dprint/dprint-plugin-markdown
- Prettier (listed last because it's intentionally hard to configure)

I think a good PR that resolves this issue would have a comparison of the output of these tools on one of our files, along with integration of the tool into CI so that we can catch issues going forward.

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

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

Hướng nghiên cứu

Bắt đầu với CONTRIBUTING.md và một tệp Markdown đại diện trong repository. So sánh mdformat, markdownlint, dprint với plugin Markdown của nó và Prettier như đã đề xuất, sau đó ghi lại các quy ước được chọn và tích hợp kiểm tra đã chọn vào CI để các đầu ra Markdown trong tương lai được kiểm tra tự động.

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

Đánh giá

Công nghệ
markdown
Lĩnh vực
ci-cd, documentation
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
Khá rõ ràng
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.