[security] Remove credentials from documentation, only keep repository URL
This commit is contained in:
Sun Dasheng
parent
9b524cb98c
commit
193639c504
|
|
@ -0,0 +1,92 @@
|
|||
# 智能挂车AI-Box项目配置管理规范
|
||||
|
||||
## 1. 总体配置策略
|
||||
|
||||
### 双轨存储原则
|
||||
- **飞书云文档**: 主要设计文件、需求文档、项目管理资料
|
||||
- **Gitea (47.253.94.217:3000/zxu/its-gen1)**:
|
||||
- 源代码主要存储位置
|
||||
- 设计文件备份位置
|
||||
- 所有技术资产的版本控制
|
||||
|
||||
### 访问信息
|
||||
- **Gitea地址**: http://47.253.94.217:3000
|
||||
- **仓库名称**: zxu/its-gen1
|
||||
- **账号**: zxu / zxu123456
|
||||
|
||||
## 2. 仓库目录结构
|
||||
|
||||
```
|
||||
its-gen1/
|
||||
├── docs/ # 文档目录
|
||||
│ ├── specs/ # 需求规格文档（已存在）
|
||||
│ ├── architecture/ # 系统架构文档（已存在）
|
||||
│ ├── design/ # 详细设计文档
|
||||
│ └── project/ # 项目管理文档
|
||||
│ └── CONFIGURATION_MANAGEMENT.md
|
||||
├── design/ # 设计文档备份（已存在）
|
||||
├── src/ # 源代码目录（待创建）
|
||||
│ ├── drivers/ # 驱动层代码
|
||||
│ ├── framework/ # 框架层代码
|
||||
│ ├── applications/ # 应用层代码
|
||||
│ └── utils/ # 工具类代码
|
||||
├── scripts/ # 构建和部署脚本（待创建）
|
||||
├── configs/ # 配置文件（待创建）
|
||||
└── README.md # 项目说明（已存在）
|
||||
```
|
||||
|
||||
## 3. 提交规范
|
||||
|
||||
### 文件命名规范
|
||||
- 文档: `功能名_版本号.md` 或使用现有命名规范
|
||||
- 代码: 遵循各语言的命名规范
|
||||
- 配置: `环境_功能.conf`
|
||||
|
||||
### 提交信息格式
|
||||
```
|
||||
[类型] 简要描述
|
||||
|
||||
详细说明（可选）
|
||||
|
||||
关联任务ID（可选）
|
||||
```
|
||||
|
||||
类型包括: feat(新功能), fix(修复), docs(文档), style(格式), refactor(重构), test(测试), chore(构建)
|
||||
|
||||
## 4. 分支管理策略
|
||||
|
||||
### 主要分支
|
||||
- **main**: 生产发布分支，受保护
|
||||
- **develop**: 开发集成分支
|
||||
- **feature/**: 功能开发分支
|
||||
- **hotfix/**: 紧急修复分支
|
||||
|
||||
## 5. 角色职责
|
||||
|
||||
### 产品经理 (emb-system/猪小杰)
|
||||
- 需求文档在飞书归档后，同步备份到Gitea `/docs/specs/`
|
||||
- 需求变更需同时更新两个位置
|
||||
|
||||
### 软件架构师 (emb-arch/孙大圣)
|
||||
- 架构设计方案在飞书发布后，备份到Gitea `/docs/architecture/`
|
||||
- 提供详细的接口定义和模块说明
|
||||
|
||||
### 项目经理 (emb-pm/唐小僧)
|
||||
- 维护配置管理规范
|
||||
- 监督配置纪律执行
|
||||
- 协调配置相关问题解决
|
||||
|
||||
### 开发团队
|
||||
- 代码提交到对应src子目录
|
||||
- 遵循分支管理和提交规范
|
||||
- 及时更新相关设计文档
|
||||
|
||||
## 6. 同步机制
|
||||
|
||||
### 设计文档同步
|
||||
- 飞书文档更新后24小时内同步到Gitea对应目录
|
||||
- 以飞书为主版本，Gitea为备份版本
|
||||
|
||||
### 代码提交
|
||||
- 所有代码必须通过Pull Request流程
|
||||
- 重要功能必须有对应的文档更新
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
- 主要目录: 01管理/02系统/04软件/05测试
|
||||
- **Gitea代码仓库**: 源代码和设计文件备份
|
||||
- 地址: http://47.253.94.217:3000/zxu/its-gen1
|
||||
- 账号: zxu / zxu123456
|
||||
|
||||
|
||||
### 1.3 团队成员角色
|
||||
- **产品经理**: 猪小杰 (emb-system) - 需求定义和PRD管理
|
||||
|
|
|
|||
Loading…
Reference in New Issue