logo
0
0
WeChat Login
docs: update README.md

commit-practice

本项目提供 Git 多人协作流程的指导说明,并提供位置让大家练习 Git 的各种操作

一、Fork 仓库

  1. CNB 平台 进入本仓库页面。

  2. 点击页面右上角 Fork 按钮,将仓库复制到您个人组织下的仓库。

    原始仓库 → 您的个人仓库
  3. Fork 完成后,您将被跳转到您 fork 的仓库页面。

二、创建自己的分支

在 CNB 平台上创建云开发空间

  1. 在您 fork 的仓库页面,点击 + 新建 按钮,选择 新建分支

  2. 输入新分支名称(建议使用您的名字或功能描述,这里以 cnbcool 为例):

    cnbcool
  3. CNB 平台会自动创建一个独立的云开发空间,您可以在其中进行开发。

本地操作(可选)

如果您习惯本地开发,可使用以下命令:

# 克隆您 fork 的仓库 git clone https://cnb.cool/gdmuna/commit-practice.git cd commit-practice # 创建并切换到新分支 git checkout -b 您的分支名称

三、新增内容

重要:每个人创建自己的文件夹

为避免多人同时修改同一文件导致冲突,请每个人在自己的文件夹内添加代码

文件夹结构示例

commit-practice/ ├── README.md ├── hajimi/ │ ├── demo.js │ └── test.js ├── mihoyoo/ │ ├── main.py │ └── utils.py └── mihomoo/ └── app.vue

注意事项

  • 文件夹名称建议使用英文或拼音
  • 避免在根目录下直接添加文件
  • 提交前检查是否有同名文件冲突

四、Commit 代码

添加修改

# 添加所有修改 git add . # 或只添加特定文件 git add 您的用户名/您的文件

提交代码

git commit -m "feat: 添加 xxx 功能"

提交信息规范

类型说明示例
feat:新功能feat: 添加用户登录模块
fix:修复 Bugfix: 修复登录超时问题
docs:文档更新docs: 更新 API 文档
style:代码格式(不影响功能)style: 格式化代码
refactor:重构(不是修复也不是新功能)refactor: 优化用户模块结构
test:测试相关test: 添加单元测试
chore:构建/工具相关chore: 更新依赖版本

推送到远程

# 推送分支到您的 fork 仓库 git push origin 您的分支名称

五、创建合并请求 (PR)

在 CNB 平台上操作

  1. 在您 fork 的仓库页面,点击 创建合并请求 按钮。

  2. 选择源分支(您的分支)和目标分支(原始仓库的默认分支)。

  3. 填写 PR 信息(会由 AI 自动生成):

    • 标题:简洁描述本次修改
    • 描述:详细说明修改内容、动机和影响
  4. 点击 提交 创建 PR。

PR 审核

  • 等待仓库维护者审核您的 PR
  • 如果有修改建议,请及时响应并更新代码
  • 审核通过后,您的代码将被合并到主分支

六、拉取上游仓库的最新代码

当其他人更改代码时,您需要同步上游仓库的更新。

添加上游仓库

# 添加原始仓库为上游源(仅需执行一次) git remote add upstream https://cnb.cool/gdmuna/commit-practice.git # 验证远程仓库配置 git remote -v

同步更新

  1. 切换到本地主分支

    git checkout main
  2. 拉取上游仓库的最新代码

    git fetch upstream git merge upstream/main
  3. 如果有冲突,解决冲突后提交:

    # 解决冲突后 git add . git commit -m "merge: 解决与上游仓库的冲突"
  4. 更新您自己的分支

    git checkout 您的分支名 git merge main

定期同步

在开始新任务前,先同步主分支的最新代码,避免积累太多变更导致冲突难以解决。


七、CNB 平台特有功能

Branch-as-Environment

CNB 平台的分支即环境特性:

  • 每个分支会自动创建一个独立的云开发空间
  • 无需手动配置环境,开箱即用
  • 支持多人协作,每个功能有独立环境

使用云开发空间

  1. 在分支列表中点击您的分支
  2. 进入云开发空间,进行在线开发
  3. 编写代码后,系统会自动保存
  4. 在空间中可以直接提交代码

八、注意事项

⚠️ 警告说明
不能直接修改 main/master 分支所有修改应在功能分支中进行
每次修改前创建新分支避免污染主分支
提交信息要有意义方便代码审查和历史追溯
及时同步上游更新避免重大冲突
避免多人修改同一文件每人使用自己的文件夹

九、常见问题

Q: Fork 后如何同步原始仓库的更新?

A: 参考本文档第六部分的"拉取上游仓库的最新代码"。

Q: 多人同时修改同一文件怎么办?

A: 请每人使用自己的文件夹,避免修改同一文件。确实需要修改同一文件时,请先拉取最新代码,然后与其他人沟通协调。

Q: PR 被拒绝怎么办?

A: 查看拒绝原因,根据建议修改代码后重新提交。

Q: 如何使用 CNB 平台的云开发空间?

A: 在分支列表中点击您的分支名称,即可进入对应的云开发环境。