ContainerSolutions/terraform-examples

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

オープン

#183 opened on 2022/09/01

GitHub で見るコントリビューターガイド
 (2 件のコメント) (1 件のリアクション) (0 人の担当者)HCL (52 件のフォーク)github user discovery
CIdocumentationgood first issue

Repository metrics

Stars
 (162 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

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

コントリビューターガイド

調査方針
課題にリンクされた規約を確認し、grepやbashなどのツールを使用して各規約（ファイル名、見出しなど）をチェックするシェルスクリプトを作成し、CIに追加してください。
技術スタック
shell
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Gitshell
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80