vala-lang/vala-docs

Add Markdown Linter Action/Config for Standardization

Open

#110 ouverte le 7 oct. 2025

Voir sur GitHub
 (5 commentaires) (0 réactions) (0 assignés) (28 forks)auto 404
enhancementhelp wanted

Métriques du dépôt

Stars
 (18 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Configurez un workflow GitHub Actions qui exécute markdownlint à chaque push/pull request et créez un fichier .markdownlint.json à la racine pour imposer un style cohérent. Référez vous aux ressources liées pour les options de configuration.
Stack technique
Aucun
Domaine
documentationdevops
Type d'issue
DevOps
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitHub ActionsMarkdownYAML
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75