diff --git a/init/README.md b/init/README.md new file mode 100644 index 0000000..40aba66 --- /dev/null +++ b/init/README.md @@ -0,0 +1 @@ +# 初始化 diff --git a/init/repo_naming.md b/init/repo_naming.md new file mode 100644 index 0000000..e45f118 --- /dev/null +++ b/init/repo_naming.md @@ -0,0 +1,30 @@ +# 仓库命名 + +## 代码类仓库 + +命名遵循`-(-)`的格式。 +比如:`qtcloud-data-provider`; `qtcloud-sdk-py` + +主要的品牌见“量潮品牌管理手册”。 + +主要的类别包括: + +- `server`、`provider`: 服务端。后者特指云的服务端。 +- `client`、`console`: 客户端、控制台。后者特指云的控制台,SDK和CLI也是客户端的具体形式。 +- `sdk`: SDK。 +- `cli`: 命令行工具(CLI)。 + +## 文档类仓库 + +命名遵循`--of-`的格式。 +比如:`quanttide-handbook-of-devops` + +主要的类别包括: + +- `tutorial`: 基础教程 +- `handbook`: 工作手册 +- `specification`: 工程标准 +- `template`: 模板项目。遵循`cookiecutter`模板规范。 +- `example`: 示例项目 +- `dataset`: 数据集 +- `research`: 研究项目