carpentries-incubator / carpentries-incubator/python-intermediate-development

Configure a markdown linter for editing our lesson source files

Aperta Adatta ai principianti
#538 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
TeX
Stelle
63
Fork
77
Merge medio
20h 8m
PR unite (30g)
3

Descrizione

This was mentioned in #437 which I think was prematurely closed. The formatting / linting of markdown files across our lesson contain many inconsistencies, and often leads to me getting sidetracked fixing things that should be enforced by a linter/formatter. `markdownlint` seems like the tool for the job, so I will draft up a config file that enforces The Carpentries Workbench Style and makes editing easier for us.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia esaminando l’issue #437 e i file Markdown sorgente della lezione, quindi confronta markdownlint con il Carpentries Workbench Style. Il lavoro è completato quando esiste una configurazione di markdownlint che applica in modo coerente la formattazione concordata alle fonti della lezione e supporta una modifica più semplice.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
markdown
Ambito
tooling
Tipo di issue
Funzionalità
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
64/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.