Define markdown convention/formatting rules
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- markdown
- Ambito
- ci-cd, documentation
Direzione di ricerca
Inizia con CONTRIBUTING.md e un file Markdown rappresentativo del repository. Confronta mdformat, markdownlint, dprint con il relativo plugin Markdown e Prettier come proposto, quindi documenta le convenzioni selezionate e integra il controllo scelto in CI, in modo che il futuro output Markdown venga verificato automaticamente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Rust
- Stelle
- 137
- Fork
- 88
- Merge medio
- 10h 38m
- PR unite (30g)
- 2
Preparare l'ambiente
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di bytecodealliance/component-docs
-
Difficoltà 2/5 Mezza giornata Idoneità per principianti 72/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
bytecodealliance/component-docs#294 · 1 commento ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 68/100
bytecodealliance/component-docs#376 · 1 commento ·
-
Fix Python TutorialApertabug lang/python
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
bytecodealliance/component-docs#348 · 2 commenti ·
Tutte le issue di bytecodealliance/component-docs
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
arkworks-rs/algebra#1161 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
lbjlaq/Antigravity-Manager#3525 · 2 commenti · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
Registry Scheduling: startup logging goes to stdout, colliding with a stdout audit destinationApertaagent-ready area:platform bug criticality:p3 rust triage:needs-implementation
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
registrystack/registry-stack#1583 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
I maintainer di solito rispondono entro 1 giorno
-
Docs: "Work with Codex from anywhere" page still claims Windows mobile support is "coming soon"Apertaapp documentation remote windows-os
Difficoltà 1/5 1-3 ore Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno