guanyuankai
/
git-workshop
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(scope): README更新 

更新了README的格式。
修复了其中的一些命名错误。
This commit is contained in:
Guan Yuankai 2025-12-15 15:40:57 +08:00
parent 7999545a2b
commit 3f8f2afe0e
1 changed files with 28 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -29,8 +29,9 @@ git checkout develop
git pull origin develop git pull origin develop
``` ```
2. 创建你的功能分支 ### 2. 创建你的功能分支
根据规范，分支命名格式为：feat/<issue-id>-<description>。 本次演练假设任务 ID 为 101，请用你的名字拼音作为描述。
根据规范，分支命名格式为：feat/<issue-id>-<description>。 本次演练假设任务 ID 为 101，请用你的名字拼音作为描述。
示例：如果你的名字是夏小芮(Xia xiaorui) 示例：如果你的名字是夏小芮(Xia xiaorui)
@ -39,10 +40,11 @@ git pull origin develop
git checkout -b feat/training-xxr git checkout -b feat/training-xxr
``` ```
3. 创建个人工作区与代码 ### 3. 创建个人工作区与代码
为了避免演练冲突，请在 participants 目录下创建一个以你名字命名的文件夹。
创建目录：participants/zhangsan/ 为了避免演练冲突，请在 participants 目录下创建一个以你名字命名的文件夹。
创建目录：participants/xxr/
创建文件：在该目录下创建一个 Java 类文件，例如 UserDetail.java。 创建文件：在该目录下创建一个 Java 类文件，例如 UserDetail.java。
@ -59,7 +61,7 @@ git checkout -b feat/training-xxr
代码示例： 代码示例：
```Java ```Java
package participants.zhangsan; package participants.xxr;
public class UserDetail { public class UserDetail {
@ -74,10 +76,11 @@ public class UserDetail {
} }
``` ```
4. 提交代码 (Commit) ### 4. 提交代码 (Commit)
将文件添加到暂存区并提交。请遵循 Conventional Commits 规范。
格式：<type>(<scope>): <subject> 将文件添加到暂存区并提交。请遵循 Conventional Commits 规范。
格式：`<type>(<scope>): <subject>`
```Bash ```Bash
git add . git add .
@ -86,18 +89,19 @@ git commit -m "feat(training): add zhangsan user detail implementation"
⚠️ 注意：Commit Message 必须全英文，Subject 使用祈使句，结尾不要加句号。 ⚠️ 注意：Commit Message 必须全英文，Subject 使用祈使句，结尾不要加句号。
5. ⚡️ 同步代码 (关键步骤！) ### 5. 同步代码 (关键步骤！)
在你开发的过程中，develop 分支可能已经有了别人的提交。为了保持提交历史整洁（线性历史），在 Push 之前，必须 进行 Rebase。
在你开发的过程中，develop 分支可能已经有了别人的提交。为了保持提交历史整洁（线性历史），在 Push 之前，必须 进行 Rebase。
```Bash ```Bash
# 1. 先切换回 develop 拉取最新代码 (是一个好习惯，或者直接 fetch) # 1. 先切换回 develop 拉取最新代码 (是一个好习惯，或者直接 fetch)
git fetch origin develop git fetch origin develop
# 2. 确保你在你的功能分支上 # 2. 确保你在你的功能分支上
git checkout feat/training-zhangsan git checkout feat/training-zhangsan
# 3. 执行变基 (Rebase) # 3. 执行变基 (Rebase)
git rebase origin/develop git rebase origin/develop
``` ```
@ -111,8 +115,9 @@ git rebase --continue
绝对禁止 在此处使用 git merge，这会产生无意义的 Merge Commit 节点。 绝对禁止 在此处使用 git merge，这会产生无意义的 Merge Commit 节点。
6. 推送与提交 PR ### 6. 推送与提交 PR
代码同步并测试无误后，推送到远程仓库。
代码同步并测试无误后，推送到远程仓库。
```Bash ```Bash
git push origin feat/training-xxr git push origin feat/training-xxr
@ -136,12 +141,12 @@ git push origin feat/training-xxr
在提交 PR 前，请自我检查： 在提交 PR 前，请自我检查：
[ ] 分支名是否小写？(e.g., feat/...) - [ ] 分支名是否小写？(e.g., feat/...)
[ ] 代码缩进是否为 4 空格？左大括号是否没换行？ - [ ] 代码缩进是否为 4 空格？左大括号是否没换行？
[ ] Commit Message 是否符合格式？(e.g., feat(scope): ...) - [ ] Commit Message 是否符合格式？(e.g., feat(scope): ...)
[ ] 是否执行了 Rebase 操作？ (历史记录是否是一条直线？) - [ ] 是否执行了 Rebase 操作？ (历史记录是否是一条直线？)
Happy Coding! 💻 Happy Coding! 💻