Wang Defa
9ff0daa938
All checks were successful
Build and Release / build-and-test (arm64, alpine) (push) Successful in 30s
Build and Release / build-and-test (amd64, alpine) (push) Successful in 42s
Build and Release / build-and-test (arm64, ubuntu) (push) Successful in 41s
Build and Release / build-and-test (amd64, ubuntu) (push) Successful in 54s
Build and Release / release (push) Has been skipped
- 重构配置方式：使用 params.conf 替代命令行参数 - postinst 自动创建配置文件，升级时保护用户配置 - 初始化 llmdoc 文档系统（概述、架构、指南、参考） - 创建 README.md 和配置指南 - 提供完整的配置模板示例 配置文件优势：升级安全、集中管理、易于维护
79 lines
1.4 KiB
Markdown
79 lines
1.4 KiB
Markdown
# Git 协作规范
|
|
|
|
## 分支管理
|
|
|
|
### 主分支
|
|
- `main`: 稳定版本
|
|
- `develop`: 开发分支
|
|
|
|
### 开发流程
|
|
1. 从 `develop` 创建功能分支
|
|
2. 功能分支命名规范：
|
|
- `feature/` 前缀表示新功能
|
|
- `bugfix/` 前缀表示 bug 修复
|
|
- `docs/` 前缀表示文档更新
|
|
|
|
### 示例分支创建
|
|
```bash
|
|
# 从 develop 创建功能分支
|
|
git checkout develop
|
|
git pull origin develop
|
|
git checkout -b feature/add-architecture-docs
|
|
```
|
|
|
|
## 提交规范
|
|
|
|
### 提交信息格式
|
|
```
|
|
<类型>: <简要描述>
|
|
|
|
[可选的详细说明]
|
|
|
|
[关联的 issue 或 PR]
|
|
```
|
|
|
|
### 类型定义
|
|
- `feat`: 新功能
|
|
- `fix`: 修复 bug
|
|
- `docs`: 文档更新
|
|
- `style`: 代码风格调整
|
|
- `refactor`: 重构
|
|
- `test`: 测试相关
|
|
- `build`: 构建系统或外部依赖变更
|
|
- `ci`: CI 配置变更
|
|
|
|
### 提交示例
|
|
```bash
|
|
docs: 添加 p2pool 构建文档系统
|
|
|
|
- 创建 llmdoc 目录结构
|
|
- 添加项目概述文档
|
|
- 编写编码和 Git 规范文档
|
|
|
|
关联 Issue: #123
|
|
```
|
|
|
|
## 代码审查
|
|
|
|
### 合并请求(PR)规范
|
|
- 所有 PR 必须从功能分支提交到 `develop`
|
|
- PR 标题应简洁描述变更
|
|
- PR 描述必须包含：
|
|
1. 变更的目的
|
|
2. 具体实现
|
|
3. 测试方法
|
|
- 至少需要一个审查者批准
|
|
|
|
## 版本标签
|
|
|
|
### 版本命名
|
|
- 使用语义化版本 (Semantic Versioning)
|
|
- 格式：`vMAJOR.MINOR.PATCH`
|
|
- 示例：`v4.12.0`
|
|
|
|
### 发布流程
|
|
```bash
|
|
# 创建版本标签
|
|
git tag v4.12.0
|
|
git push origin v4.12.0
|
|
``` |