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