docs: update contributing

This commit is contained in:
ghmark675
2025-11-11 20:10:10 +08:00
parent 3a96bd4186
commit b6c5c4182c
2 changed files with 22 additions and 44 deletions
+6 -17
View File
@@ -16,16 +16,7 @@ git clone https://github.com/<你的用户名>/<仓库名>.git
cd <仓库名>
```
## 3️⃣ 切换到 `dev` 分支(确保基于最新代码开发)
```bash
git checkout dev
git pull origin dev # 同步远程 dev 分支的最新代码
```
> ⚠️ 请务必从 **`dev` 分支** 创建你的功能分支,而不是从 `main`。
## 4️⃣ 创建功能分支
## 3️⃣ 创建功能分支
```bash
git checkout -b feature/你的功能名
@@ -33,12 +24,12 @@ git checkout -b feature/你的功能名
> 建议分支命名规范:`feature/xxx` 或 `fix/xxx`,便于识别功能或修复类型。
## 5️⃣ 开发与测试
## 4️⃣ 开发与测试
* 进行代码修改,保持项目代码风格一致。
* 确保新增功能或修复通过测试。
## 6️⃣ 提交修改
## 5️⃣ 提交修改
```bash
git add .
@@ -47,19 +38,17 @@ git commit -m "类型: 简短描述"
> 推荐遵循 [Conventional Commits](https://www.conventionalcommits.org/zh-hans/),保持提交记录清晰。
## 7️⃣ 推送到远程仓库
## 6️⃣ 推送到远程仓库
```bash
git push origin feature/你的功能名
```
## 8️⃣ 发起 Pull Request
## 7️⃣ 发起 Pull Request
1. 在 GitHub 上点击 **New Pull Request**
2. **目标分支必须是本仓库的 `dev` 分支**
2. **目标分支必须是本仓库的 `main` 分支**
3. 填写 PR 描述:
* 说明主要改动内容
* 如有相关 issue,请在 PR 中关联
> ⚠️ PR **绝对不要指向 `main` 分支**,避免影响主线稳定性。