ContainerSolutions/terraform-examples

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

開放

#183 建立於 2022年9月1日

在 GitHub 查看貢獻者指南
 (2 則留言) (1 個反應) (0 位負責人)HCL (52 個分叉)github user discovery
CIdocumentationgood first issue

倉庫指標

星標
 (162 顆星)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

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

貢獻者指南

研究方向
查看問題中連結的約定，然後建立一個 shell 腳本，使用 grep 或 bash 等工具檢查每個約定（例如檔案命名、標題），並將其添加到 CI 中。
技術棧
shell
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Gitshell
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80