vala-lang/vala-docs

Add Markdown Linter Action/Config for Standardization

Open

#110 geöffnet am 7. Okt. 2025

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen) (28 Forks)auto 404
enhancementhelp wanted

Repository-Metriken

Stars
 (18 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Description

Since markdown is quite flexible, perhaps it would be useful to add a linter to push for a more consistent markdown style.

Some editors for markdown have linters installed (neovim with markdownlint-cli2) which would benefit from following a linter standard.

It may be beneficial in some editors and for consistency, but it also may increase friction to add to the docs.

Additional Resources

Contributor Guide

Research-Richtung
Richte einen GitHub Actions Workflow ein, der bei jedem Push/Pull Request markdownlint ausführt, und erstelle eine .markdownlint.json Konfigurationsdatei im Stammverzeichnis, um einen einheitlichen Stil durchzusetzen. Siehe die verlinkten Ressourcen für Konfigurationsoptionen.
Tech Stack
Keine
Domain
documentationdevops
Issue Type
DevOps
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitHub ActionsMarkdownYAML
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75