Define markdown convention/formatting rules
まだ誰も着手していません。
評価
- 難易度
- 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
- フォーク
- 88
- 平均マージ
- 10時間 38分
- マージ済み PR（30日）
- 2
環境構築
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
bytecodealliance/component-docs#376 · コメント 1 件 ·
-
Fix Python Tutorialオープンbug lang/python
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
bytecodealliance/component-docs#348 · コメント 2 件 ·
bytecodealliance/component-docs の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
trailofbits/dylint#2107 ·
メンテナーはふだん 1 日以内に返信
-
area:cli bug good first issue priority:medium
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
メンテナーはふだん 1 日以内に返信
-
arrays_zip with two same-named inputs fails with "ArrowArray struct has 2 children (expected 1)"オープンbug requires-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
apache/datafusion-comet#6251 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
bug false-positive harper-core linting
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Automattic/harper#4471 ·
メンテナーはふだん 1 日以内に返信