ContainerSolutions/terraform-examples

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

Ouverte

#183 ouverte le 1 sept. 2022

Voir sur GitHubGuide contributeur
 (2 commentaires) (1 réaction) (0 personne assignée)HCL (52 forks)github user discovery
CIdocumentationgood first issue

Métriques du dépôt

Stars
 (162 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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

Guide contributeur

Direction de recherche
Consultez les conventions liées dans le problème, puis créez un script shell qui vérifie chaque convention (par exemple, noms de fichiers, en têtes) à l'aide d'outils comme grep ou bash, et ajoutez le au CI.
Stack technique
shell
Domaine
documentation
Type d'issue
Documentation
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
Gitshell
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80