Define markdown convention/formatting rules
還沒有人認領這個 Issue。
評估
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 新手友好度
- 35/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- markdown
- 領域
- ci-cd, documentation
研究方向
從 CONTRIBUTING.md 和儲存庫中一個具代表性的 Markdown 檔案開始。按照提議比較 mdformat、markdownlint、搭配其 Markdown 外掛程式的 dprint 和 Prettier，然後記錄選定的慣例，並將選定的檢查整合至 CI 中，以便自動檢查未來的 Markdown 輸出。
由索引模型根據 Issue 內容生成。
描述
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.
- 主要語言
- Rust
- 星號
- 137
- 分支
- 89
- 平均合併
- 2 天 6 分鐘
- 30 天內合併 PR
- 1
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
bytecodealliance/component-docs 的其他 Issue
-
難度 2/5 半天 新手友好度 72/100
-
難度 2/5 1-3 小時 新手友好度 65/100
-
難度 2/5 1-3 小時 新手友好度 68/100
bytecodealliance/component-docs#294 · 1 則留言 ·
-
難度 2/5 1-3 小時 新手友好度 55/100
-
documentation enhancement lang/rust
難度 3/5 1-2 天 新手友好度 78/100
查看 bytecodealliance/component-docs 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 66/100
git-ai-project/git-ai#2434 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 84/100
peteonrails/voxtype#909 ·
維護者通常 2 天內回覆
-
難度 2/5 1-3 小時 新手友好度 82/100
kucherenko/jscpd#1239 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 76/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 69/100
alchemyplatform/rundler#1358 ·
維護者通常 3 天內回覆