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

Configure a markdown linter for editing our lesson source files

Offen Anfängerfreundlich
#538 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TeX
Sterne
63
Forks
77
Ø Merge
20 Std. 8 Min.
Gemergte PRs (30 T.)
3

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit der Durchsicht von Issue #437 und den Markdown-Quelldateien der Lektion und vergleiche anschließend markdownlint mit dem Carpentries Workbench Style. Erledigt ist die Aufgabe, wenn eine markdownlint-Konfiguration vorhanden ist, die die vereinbarte Formatierung in den Quellen der Lektion konsistent erzwingt und eine einfachere Bearbeitung unterstützt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
markdown
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
64/100

Neue Issues direkt in Ihr Postfach

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