bytecodealliance / bytecodealliance/component-docs

Define markdown convention/formatting rules

オープン
#292 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement quality tooling
主要言語
Rust
スター
137
フォーク
88
平均マージ
5日 12時間
マージ済み PR(30日)
4

説明

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.

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。