bytecodealliance / bytecodealliance/component-docs

Define markdown convention/formatting rules

Offen
#292 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement quality tooling
Vorherrschende Sprache
Rust
Sterne
137
Forks
88
Ø Merge
5 T. 12 Std.
Gemergte PRs (30 T.)
4

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.