Compare commits
7 Commits
| Author | SHA1 | Date |
|---|---|---|
|
|
efb96a9452 | |
|
|
336f2d2d6e | |
|
|
6db07475d8 | |
|
|
9f9c8e1179 | |
|
|
78f416782c | |
|
|
e230cd422b | |
|
|
34e923cb01 |
|
|
@ -0,0 +1,24 @@
|
|||
# GPU开源生态挑战赛赛题解读
|
||||
## 一、 赛题核心定位
|
||||
本赛题服务于社区开源生态,参赛选手可以选择自己的方式为开源生态作出贡献。
|
||||
这份赛题解读我们以“参与MinerU开源社区上游贡献支持MACA软件栈”为例子,让大家从一个具体例子中了解如何为开源生态作出贡献。
|
||||
此次案例以四个步骤进行,分别为阅读相关文档,在MACA上安装并测试,撰写使用文档,在上游社区提交PR,其核心任务在于向上游社区提交基于MACA安装和使用官方的MinerU仓库详细的指导手册。
|
||||
|
||||
## 二、 赛题步骤分析
|
||||
### 1.阅读相关文档
|
||||
首先阅读MinerU社区文档和MACA软件参考文档,了解到因为部分依赖兼容问题,无法在MACA上直接使用MinerU,需要重新安装部分依赖并测试相关功能。
|
||||
### 2.在MACA上安装并测试
|
||||
发现MinerU中有一些cuda版本包的依赖,这些依赖在MACA上并不兼容,所以使用--no-deps安装核心模块,并自行安装其它需要使用的模块,安装完成后进行功能测试,比较是否能够完成MinerU的基础功能,若能够完成,则说明安装成功。
|
||||
### 3.撰写安装和使用文档
|
||||
测试完成后,按照安装步骤,编写安装文档,提供一份在MACA上安装和使用MinerU的详细指导手册。
|
||||
### 4.在上游社区提交PR
|
||||
完成文档后,需要在上游社区提交PR(可以参考[how-to-contribute.md](https://gitlink.org.cn/ccf-ai-infra/GPUCodeForces/tree/main/how-to-contribute.md)),等待社区管理员的回复并积极与社区管理员探讨文档中可能存在的问题,直至文档被合并到上游社区,才算是真正作出贡献。
|
||||
|
||||
##三 、赛题核心考察点
|
||||
技术迁移与适配能力:深入理解技术差异,解决兼容问题
|
||||
开源生态贡献能力:如何协作,发现问题与反馈
|
||||
创新与价值创造能力:选题价值,前瞻性
|
||||
工程化与规范性:专业、可靠、易于复用
|
||||
|
||||
##四、注意事项与提醒
|
||||
本赛题参赛者可以选择多种方式进行,我们也鼓励参赛者通过自己的想法让社区开源生态百花齐放,该例也只是其中一种参赛方式,但无论选择何种方式,都应注重项目可复现性和工程规范性,并提交可供评委验证的相关文档或PR链接。
|
||||
|
|
@ -0,0 +1,84 @@
|
|||
# 项目贡献指南
|
||||
|
||||
本项目协作采用标准的Pull Request(PR)流程机制,PR流程是开源项目协作和代码管理的核心机制。以下是创建和处理PR的详细步骤:
|
||||
|
||||
## 0. CLA签署
|
||||
- **目的**:项目内Pull Request需要贡献者签署贡献者协议后方可合并,为保证后续项目的顺利,建议提前进行CLA签署。
|
||||
-**步骤**:
|
||||
-点击[CLA签署链接](https://www.gitlink.org.cn/ccf-ai-infra/cla/governance),滑动阅读后在页面下方填写真实姓名,并选择参赛所用账号的邮箱即可
|
||||
|
||||
## 1. Fork项目仓库
|
||||
- **目的**:将原始仓库复制到您的Gitlink(或github)账户下,以便您可以进行修改。
|
||||
- **步骤**:
|
||||
- 在Gitlink(或github)上找到[GPUKernelContest](https://gitee.com/ccf-ai-infra/GPUKernelContest)。
|
||||
- 点击页面右上角的“Fork”按钮,将该仓库复制到您的Gitee账户下。
|
||||
|
||||
## 2. Clone项目仓库
|
||||
- **目的**:将您Fork的项目仓库克隆到本地,以便在本地进行修改。
|
||||
- **步骤**:
|
||||
- 在您的本地机器上,使用`git clone`命令将项目仓库Fork的仓库克隆到本地。
|
||||
```sh
|
||||
git clone https://gitlink.org.cn/gitlinkuseid/GPUKernelContest.git
|
||||
```
|
||||
备注:`gitlinkuseid替换您的url`。
|
||||
|
||||
|
||||
## 3. 创建新分支进行开发
|
||||
- **目的**:在新的分支上进行修改,避免直接修改主分支。
|
||||
- **步骤**:
|
||||
- 进入克隆的仓库目录。
|
||||
```sh
|
||||
cd GPUKernelContest
|
||||
```
|
||||
- 创建一个新的分支来(例如:`dev`分支)进行您的项目创作或者修订。
|
||||
```sh
|
||||
git checkout -b dev
|
||||
```
|
||||
|
||||
## 4. 进行修改
|
||||
- **目的**:在您的新分支上`dev`进行项目创作或者修订。
|
||||
- **步骤**:
|
||||
- 在您的`dev`分支上进行项目创作或者修订。
|
||||
- 修改完成后,添加并提交您的更改。
|
||||
```sh
|
||||
git add .
|
||||
git commit -m "描述您的修改"
|
||||
```
|
||||
|
||||
## 5. 推送修改
|
||||
- **目的**:将您的修改推送到您Fork的仓库。
|
||||
- **步骤**:
|
||||
- 将您的修改推送到您Fork的仓库。
|
||||
```sh
|
||||
git push origin dev
|
||||
```
|
||||
|
||||
## 6. 创建Pull Request
|
||||
- **目的**:向原始仓库的维护者提交您的修改,请求合并。
|
||||
- **步骤**:
|
||||
- 回到您的Gitlink账户(或github),找到您Fork的仓库。
|
||||
- 点击“New Pull Request”按钮。
|
||||
- 选择您推送的分支和原始仓库的主分支进行比较。
|
||||
- 填写PR的标题和描述,说明您的修改内容和目的。
|
||||
- 点击“Create Pull Request”按钮,提交PR。
|
||||
|
||||
## 7. 处理反馈
|
||||
- **目的**:根据项目维护者的反馈进行必要的修改。
|
||||
- **步骤**:
|
||||
- 项目维护团队或者维护者会审查您的PR,并可能提出修改意见或问题。
|
||||
- 根据反馈进行必要的修改,并重复步骤4到步骤6,直到PR被接受。
|
||||
|
||||
## 8. PR被合并
|
||||
- **目的**:一旦您的PR被接受并合并到主分支,您的贡献就正式成为项目的一部分。
|
||||
- **步骤**:
|
||||
- 项目维护者会合并您的PR。
|
||||
- 您的修改现在成为原始仓库的一部分。
|
||||
|
||||
## 9. 同步上游仓库
|
||||
- **目的**:保持您的Fork仓库与上游仓库同步。
|
||||
- **步骤**:
|
||||
- 为了保持您的Fork仓库与上游仓库同步,您需要定期从上游仓库拉取更新。
|
||||
- 登录自己的Gitlink账户(或github),找到您Fork的仓库。
|
||||
- 点击`Sync fork`按钮同步最新的上游Fork的仓库。
|
||||
|
||||
通过以上步骤,您就可以在Gitlink(或github)上有效地参与项目的协作。希望这些信息对您有所帮助!如果有任何问题,随时欢迎提问。
|
||||
Loading…
Reference in New Issue