You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

how-to-contribute.md 3.4 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. # 项目贡献指南
  2. 本项目协作采用标准的Pull Request(PR)流程机制,PR流程是开源项目协作和代码管理的核心机制。以下是创建和处理PR的详细步骤:
  3. ## 1. Fork项目仓库
  4. - **目的**:将原始仓库复制到您的Gitee(或github)账户下,以便您可以进行修改。
  5. - **步骤**:
  6. - 在Gitee(或github)上找到[GPUCodeForces](https://gitee.com/ccf-ai-infra/GPUCodeForces)。
  7. - 点击页面右上角的“Fork”按钮,将该仓库复制到您的Gitee账户下。
  8. ## 2. Clone项目仓库
  9. - **目的**:将您Fork的项目仓库克隆到本地,以便在本地进行修改。
  10. - **步骤**:
  11. - 在您的本地机器上,使用`git clone`命令将项目仓库Fork的仓库克隆到本地。
  12. ```sh
  13. git clone https://gitee.com/giteeuseid/GPUCodeForces.git
  14. ```
  15. 备注:`giteeuseid替换您的url`。
  16. ## 3. 创建新分支进行开发
  17. - **目的**:在新的分支上进行修改,避免直接修改主分支。
  18. - **步骤**:
  19. - 进入克隆的仓库目录。
  20. ```sh
  21. cd GPUKernelContest
  22. ```
  23. - 创建一个新的分支来(例如:`dev`分支)进行您的项目创作或者修订。
  24. ```sh
  25. git checkout -b dev
  26. ```
  27. ## 4. 进行修改
  28. - **目的**:在您的新分支上`dev`进行项目创作或者修订。
  29. - **步骤**:
  30. - 在您的`dev`分支上进行项目创作或者修订。
  31. - 修改完成后,添加并提交您的更改。
  32. ```sh
  33. git add .
  34. git commit -m "描述您的修改,如需要关联PR,通过fixes, closes, resolved等关键字关闭"
  35. ```
  36. 备注:
  37. * Fixes #45 → 关闭Issue #45
  38. * Resolves jquery/jquery#45 → 跨仓库关闭Issue
  39. * Closes #45, #46 → 批量关闭多个Issue
  40. ## 5. 推送修改
  41. - **目的**:将您的修改推送到您Fork的仓库。
  42. - **步骤**:
  43. - 将您的修改推送到您Fork的仓库。
  44. ```sh
  45. git push origin dev
  46. ```
  47. ## 6. 创建Pull Request
  48. - **目的**:向原始仓库的维护者提交您的修改,请求合并。
  49. - **步骤**:
  50. - 回到您的Gitee账户(或github),找到您Fork的仓库。
  51. - 点击“New Pull Request”按钮。
  52. - 选择您推送的分支和原始仓库的主分支进行比较。
  53. - 填写PR的标题和描述,说明您的修改内容和目的。
  54. - 点击“Create Pull Request”按钮,提交PR。
  55. ## 7. 处理反馈
  56. - **目的**:根据项目维护者的反馈进行必要的修改。
  57. - **步骤**:
  58. - 项目维护团队或者维护者会审查您的PR,并可能提出修改意见或问题。
  59. - 根据反馈进行必要的修改,并重复步骤4到步骤6,直到PR被接受。
  60. ## 8. PR被合并
  61. - **目的**:一旦您的PR被接受并合并到主分支,您的贡献就正式成为项目的一部分。
  62. - **步骤**:
  63. - 项目维护者会合并您的PR。
  64. - 您的修改现在成为原始仓库的一部分。
  65. ## 9. 同步上游仓库
  66. - **目的**:保持您的Fork仓库与上游仓库同步。
  67. - **步骤**:
  68. - 为了保持您的Fork仓库与上游仓库同步,您需要定期从上游仓库拉取更新。
  69. - 登录自己的Gitee账户(或github),找到您Fork的仓库。
  70. - 点击`Sync fork`按钮同步最新的上游Fork的仓库。
  71. 通过以上步骤,您就可以在Gitee(或github)上有效地参与项目的协作。希望这些信息对您有所帮助!如果有任何问题,随时欢迎提问。