Define markdown convention/formatting rules
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- markdown
- Lĩnh vực
- ci-cd, documentation
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.
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.
- Ngôn ngữ chính
- Rust
- Star
- 137
- Fork
- 88
- Merge trung bình
- 10 giờ 38 phút
- Pull request đã merge (30 ngày)
- 2
Chuẩn bị môi trường
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.
Issue khác của bytecodealliance/component-docs
-
Độ khó 2/5 Nửa ngày Mức phù hợp với người mới 72/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
[FEATURE] Add wasi-cli templates Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
bytecodealliance/component-docs#294 · 1 bình luận ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 68/100
bytecodealliance/component-docs#376 · 1 bình luận ·
-
Fix Python Tutorial Đang mởbug lang/python
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 55/100
bytecodealliance/component-docs#348 · 2 bình luận ·
Tất cả issue của bytecodealliance/component-docs
Issue tương tự
-
area:cli bug good first issue priority:high
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
rtk-ai/rtk#4249 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
Maintainer thường phản hồi trong vòng 1 ngày
-
type: bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
ActivityWatch/activitywatch#1463 · 1 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
Maintainer thường phản hồi trong vòng 1 ngày