ContainerSolutions/terraform-examples

add a `bin/check_docs.sh` script to enforce documentation conventions

Aberta

#183 aberto em 1 de set. de 2022

Ver no GitHubGuia do colaborador
 (2 comentários) (1 reação) (0 responsável)HCL (52 forks)github user discovery
CIdocumentationgood first issue

Métricas do repositório

Stars
 (162 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

  • Create check_docs.sh script
  • Automatically check documentation conventions in the script conventions
  • Add/Run the script on CI at every commit

Guia do colaborador

Direção de pesquisa
Revise as convenções vinculadas na issue, depois crie um script shell que verifique cada convenção (por exemplo, nomes de arquivos, cabeçalhos) usando ferramentas como grep ou bash, e adicione o ao CI.
Pilha de tecnologia
shell
Domain
documentation
Tipo Issue
Documentação
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
Gitshell
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80