openatom_checklist.md

文档检查CheckList

适用范围

导师在检查开放原子基金会所属孵化项目的时候，可以参照该checklist来对repo的文档进行检查

基本文档检查

• Readme 是否达标？
• Contributing 是否达标
• quickstart 是否达标
• COC 是否达标

Readme的Checklist

• 项目主Repo的根目录下是否有Readme文件（文件名可以多样）
• Readme文件是否包含了如下部分
  • 项目介绍
  • 到quickstart/contributing/coc/license的链接
• 项目介绍是否通俗易懂

QuickStart的checklist

• 项目的仓库下有「快速上手指南」文件。
• 项目的 README 文件中有「快速上手指南」的链接。
• 快速上手指南需包含以下模块和具体步骤：
  • 使用软件的先决条件（例如，软硬件要求）
  • 如何下载
  • 如何安装
  • 如何使用
• 高质量的「快速上手指南」需易使用、易查找、易理解。

Contributing的 Checklist

• 项目主 repo 的根目录中是否有贡献者指南
• 项目 readme 中是否有到贡献者指南的链接
• 贡献者指南中包含如下内容
  • 欢迎的态度
  • 贡献的内容
  • 贡献的流程
• 贡献者指南是否简介明了、清晰易懂

COC的Checklist

• 项目Readme文件中是否有到COC文件的说明和链接，链接到OpenAtom的COC或者基于该COC增补特定内容后项目本身的COC
• COC是否包含了如下部分
  • 适用范围
  • 不可接受的行为列表
  • 举报途径或者处罚方法
• COC中的内容是否通俗易懂