-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# 初始化 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# 仓库命名 | ||
|
||
## 代码类仓库 | ||
|
||
命名遵循`<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`: 研究项目 |