-
Notifications
You must be signed in to change notification settings - Fork 0
Repository (Repo) 规范
NekoRectifier edited this page Jul 26, 2023
·
3 revisions
每个“实际代码”项目都应该放置一份简明有效的 README.md 于 repo 根目录下,内容应达到:
- 简要地介绍该 repo 的主要作用。
- 如有特殊的*依赖需要,也应在 README 中特别注明。(使用二级标题 "dependcies/依赖")
- 如有其他文件需要注明的,也应在 README 中注明。
repo 中无特殊需要的,不应上传
- build/、devel/、logs/ 等编译产生的或包含不必要的编译产生的文件的文件夹;
- .idea、.vscode 等存放 IDE 配置的文件夹; 以上要求可通过在 repo 根目录下编写 .gitignore 实现。
“特殊的” 指无法通过安装基础开发环境(Ubuntu、ROS-{version}-desktop(-full) 等)所获得的依赖。
- 默认将 Repo 的可见性设为
private,如有公开需求,至少需经过组内讨论并一致同意后才能设为公开。

- 除 release 在功能性*开发项目上保留外,packages 和 environments 都应将“关闭”作为初始状态。
- 至于 description,可将其作为 readme 的总结。
1. feature —— 功能包
2. basic —— 基础依赖包