opengrow/how-to-contribute.md

3.9 KiB
Raw Blame History

项目贡献指南

本项目协作采用标准的Pull RequestPR流程机制PR流程是开源项目协作和代码管理的核心机制。以下是创建和处理PR的详细步骤

1. Fork项目仓库

  • 目的将原始仓库复制到您的Gitee或github账户下以便您可以进行修改。
  • 步骤
    • 在Gitee或github上找到GPUCodeForces
    • 点击页面右上角的“Fork”按钮将该仓库复制到您的Gitee账户下。

2-1 Clone项目仓库

  • 目的将您Fork的项目仓库克隆到本地以便在本地进行修改。
  • 步骤
    • 在您的本地机器上,使用git clone命令将项目仓库Fork的仓库克隆到本地。
      git clone https://gitee.com/giteeuseid/GPUCodeForces.git
      
      备注:giteeuseid替换您的url

2-2 如有本地仓库不需要重复Clone但需强制同步上游Fork的仓库

  • 目的将您Fork的项目仓库强制同步到最新上游的仓库。

  • 步骤

    • 进入自己Fork的仓库URL
    • 点击强制同步仓库注意如有PR不能强制同步先解决PR问题

3. 创建新分支进行开发

  • 目的:在新的分支上进行修改,避免直接修改主分支。
  • 步骤
    • 进入克隆的仓库目录。
      cd GPUKernelContest
      
    • 创建一个新的分支来(例如:dev分支)进行您的项目创作或者修订。
      git checkout -b dev
      

4. 进行修改

  • 目的:在您的新分支上dev进行项目创作或者修订。
  • 步骤
    • 在您的dev分支上进行项目创作或者修订。
    • 修改完成后,添加并提交您的更改。
      git add .
      git commit -m "描述您的修改如需要关联PR通过fixes, closes, resolved等关键字关闭"
      

备注:

  • Fixes #45 → 关闭Issue #45
  • Resolves jquery/jquery#45 → 跨仓库关闭Issue
  • Closes #45, #46 → 批量关闭多个Issue

5. 推送修改

  • 目的将您的修改推送到您Fork的仓库。
  • 步骤
    • 将您的修改推送到您Fork的仓库。
      git push origin dev
      

6. 创建Pull Request

  • 目的:向原始仓库的维护者提交您的修改,请求合并。
  • 步骤
    • 回到您的Gitee账户或github找到您Fork的仓库。
    • 点击“New Pull Request”按钮。
    • 选择您推送的分支和原始仓库的主分支进行比较。
    • 填写PR的标题和描述说明您的修改内容和目的。
    • 点击“Create Pull Request”按钮提交PR。

7. 处理反馈

  • 目的:根据项目维护者的反馈进行必要的修改。
  • 步骤
    • 项目维护团队或者维护者会审查您的PR并可能提出修改意见或问题。
    • 根据反馈进行必要的修改并重复步骤4到步骤6直到PR被接受。
    • 一个PR对应的提交建议一个commit ID提交方式可参考如下
      git add 根据PR评论新修改的文件
      git commit --amend -m "PR commit messeage"
      

8. PR被合并

  • 目的一旦您的PR被接受并合并到主分支您的贡献就正式成为项目的一部分。
  • 步骤
    • 项目维护者会合并您的PR。
    • 您的修改现在成为原始仓库的一部分。

9. 同步上游仓库

  • 目的保持您的Fork仓库与上游仓库同步。
  • 步骤
    • 为了保持您的Fork仓库与上游仓库同步您需要定期从上游仓库拉取更新。
    • 登录自己的Gitee账户或github找到您Fork的仓库。
    • 点击Sync fork按钮同步最新的上游Fork的仓库。

通过以上步骤您就可以在Gitee或github上有效地参与项目的协作。希望这些信息对您有所帮助如果有任何问题随时欢迎提问。