已关闭
docs: 新增 test-action 仓库 README 编写规范 #10
dd4574bb创建于  9月8日关闭于  9月9日
dd4574bb成员
9月8日 创建

需求背景

test-action 仓库下有多个子插件(如 precision-test 等),各插件 README 风格不一、章节缺失,用户使用时难以快速理解插件功能和配置方式。需要统一的 README 编写规范,保证文档质量和平台一致性。

需求内容

新增 README-TEMPLATE.md,定义 test-action 仓库下所有子插件 README 的:

  • 强制结构与章节顺序
  • 必填元素与可选元素
  • GitCode 平台专属约束(node16、ATOMGIT_、atomgit.、id-token: write 等)
  • 可直接复制的模板示例
  • 自检清单与 CI lint 建议
  • 参考链接

验收标准

likedislike
Ddd4574bb成员
9月8日 关联了pull request:docs(readme): 新增 test-action 仓库 README 编写规范
OopenLiBingCI成员
9月9日 关闭了 issue
Ddd4574bb成员
9月10日 关联了pull request:docs(readme): 对齐 test-action 全量插件 README 至编写规范