docs: 添加如何提交 PR 的指南 #1

Merged
yuting2003 merged 1 commits from docs/how-to-submit-pr into master 2026-07-23 14:28:46 +08:00
1 changed files with 96 additions and 0 deletions

96
docs/how-to-submit-pr.md Normal file
View File

@ -0,0 +1,96 @@
# 如何提交一个 Pull Request
Pull Request简称 PR用于把一个分支上的修改提交给项目维护者审查并在确认后合并到目标分支。
## 1. 获取仓库
```bash
git clone <仓库地址>
cd <仓库目录>
```
如果已经克隆过仓库,先同步最新代码:
```bash
git checkout master
git pull
```
## 2. 创建新分支
不要直接在 `master` 分支上修改。为本次工作创建一个名称清晰的分支:
```bash
git checkout -b docs/how-to-submit-pr
```
常见的分支名前缀包括:
- `feature/`:新增功能
- `fix/`:修复问题
- `docs/`:修改文档
## 3. 修改并提交代码
完成修改后,检查文件变化:
```bash
git status
git diff
```
然后创建提交:
```bash
git add .
git commit -m "docs: 添加 PR 提交指南"
```
提交信息应简明说明本次修改的目的。
## 4. 推送分支
```bash
git push -u origin docs/how-to-submit-pr
```
参数 `-u` 会把本地分支与远程分支关联起来,之后可直接运行 `git push`
## 5. 创建 PR
进入仓库网页,根据页面提示从刚推送的分支创建 PR并填写
- 标题:简要概括修改内容
- 描述:说明修改原因、主要变化和验证方式
- 源分支:`docs/how-to-submit-pr`
- 目标分支:`master`
也可以使用 GitLink CLI
```bash
gitlink-cli pr +create \
--title "docs: 添加 PR 提交指南" \
--head docs/how-to-submit-pr \
--base master \
--body "新增一篇从创建分支到发起 PR 的操作指南。"
```
## 6. 根据审查意见更新
如果维护者提出修改建议,继续在原分支修改并提交:
```bash
git add .
git commit -m "docs: 根据审查意见更新文档"
git push
```
新的提交会自动出现在同一个 PR 中,无需重新创建 PR。
## 提交前检查
- 修改内容与 PR 主题一致
- 没有提交密码、Token 或其他敏感信息
- 已检查格式、测试和构建结果
- PR 标题与描述清晰完整
- 目标分支选择正确