bytecodealliance / bytecodealliance/component-docs

Define markdown convention/formatting rules

Ouverte
#292 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
enhancement quality tooling
Langage dominant
Rust
Étoiles
137
Forks
88
Merge moyen
5 j 12 h
PR mergées (30 j)
4

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.