vala-lang/vala-docs

Add Markdown Linter Action/Config for Standardization

Open

#110 aperta il 7 ott 2025

Vedi su GitHub
 (5 commenti) (0 reazioni) (0 assegnatari) (28 fork)auto 404
enhancementhelp wanted

Metriche repository

Star
 (18 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Configura un workflow di GitHub Actions che esegua markdownlint su ogni push/pull request e crea un file .markdownlint.json nella radice per imporre uno stile coerente. Fai riferimento alle risorse collegate per le opzioni di configurazione.
Tech stack
Nessuno
Dominio
documentationdevops
Tipo issue
DevOps
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitHub ActionsMarkdownYAML
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75