仓库命名#
代码类仓库#
命名遵循<brand>-<category>(-<framework/language>)
的格式。
比如:qtcloud-data-provider
; qtcloud-sdk-py
主要的品牌见“量潮品牌管理手册”。
主要的类别包括:
server
、provider
: 服务端。后者特指云的服务端。client
、console
: 客户端、控制台。后者特指云的控制台,SDK和CLI也是客户端的具体形式。sdk
: SDK。cli
: 命令行工具(CLI)。
文档类仓库#
命名遵循<brand>-<category>-of-<domain>
的格式。
比如:quanttide-handbook-of-devops
主要的类别包括:
tutorial
: 基础教程handbook
: 工作手册specification
: 工程标准template
: 模板项目。遵循cookiecutter
模板规范。example
: 示例项目dataset
: 数据集research
: 研究项目