ContainerSolutions/terraform-examples

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

Offen

#183 geöffnet am 01.09.2022

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (1 Reaktion) (0 zugewiesene Personen)HCL (52 Forks)github user discovery
CIdocumentationgood first issue

Repository-Metriken

Stars
 (162 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfen Sie die im Issue verlinkten Konventionen, erstellen Sie dann ein Shell Skript, das jede Konvention (z. B. Dateinamen, Überschriften) mit Tools wie grep oder bash überprüft, und fügen Sie es zu CI hinzu.
Tech Stack
shell
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Gitshell
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80