vala-lang/vala-docs

Add Markdown Linter Action/Config for Standardization

Open

#110 aberto em 7 de out. de 2025

Ver no GitHub
 (5 comments) (0 reactions) (0 assignees) (28 forks)auto 404
enhancementhelp wanted

Métricas do repositório

Stars
 (18 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Configure um workflow do GitHub Actions que execute markdownlint em cada push/pull request e crie um arquivo .markdownlint.json na raiz para impor um estilo consistente. Consulte os recursos vinculados para opções de configuração.
Pilha de tecnologia
None
Domain
documentationdevops
Tipo Issue
DevOps
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitHub ActionsMarkdownYAML
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75