ContainerSolutions/terraform-examples

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

Aperta

#183 aperta il 1 set 2022

Vedi su GitHubGuida contributor
 (2 commenti) (1 reazione) (0 assegnatari)HCL (52 fork)github user discovery
CIdocumentationgood first issue

Metriche repository

Star
 (162 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina le convenzioni collegate nel problema, quindi crea uno script shell che controlli ogni convenzione (ad esempio, nomi di file, intestazioni) usando strumenti come grep o bash, e aggiungilo al CI.
Tech stack
shell
Dominio
documentation
Tipo issue
Documentazione
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
Gitshell
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80