OSCP Phase3 文档季|即日起至2025年5月30日|参与说明 #6658
yvonneyx posted onGitHub
2025 AntV 开源贡献计划(AntV Open Source Contribution Plan,简称 OSCP)OSCP Phase3 文档季全新来袭~
本期 OSCP 也带来了全新的玩法,做任务、赢积分,成为 Issue Hunter! 🔥
我们希望通过开源社区的力量,共同打造更友好、更易上手的 AntV 文档。本次活动目的是汇聚 AntV 的社区成员、开发者和用户,让大家在协作中享受乐趣,共同提升文档质量。快来加入我们,一起为 AntV 文档贡献力量吧!
🚀 主线任务 - 定向文档优化
此次文档季共将推出 130+ 个任务,您将和社区其他成员合作,共同改进 G2 | G6 的文档。
此次活动,我们为大家准备了各种类型的文档任务。既有适合开源新手的轻量级文档补充(标注为 good first issue),也有需要技术深度的教程优化,开发者可根据自身经验灵活选择。
此次任务共计 130+,我们将分 3 批释放。其中,首批任务正在释放中...(点击查看 AntV 文档季 - 任务列表)
每项任务完成后可获得 20-50 积分奖励(1积分≈1元可兑换)。
🐛 支线任务 - 文档捉"虫"
AntV OSCP 全新推出「隐藏任务」—— 文档捉"虫"挑战!
您可以针对 AntV 全栈 G | G2 | F2 | G6 | X6 | L7 | AVA 文档中存在的各种体验问题进行捉虫,包括但不限于文档内容合规性、准确性、规范性和低错等。欢迎直接提交 Pull Request 进行修正!
PR 合并后,将获得相应的积分奖励!(1积分≈1元可兑换)
- 赏金规则:
贡献类型 | 积分 | 评估标准 |
---|---|---|
错别字/标点修正 | 1 | 每处独立错误计分,同一段落内连续错误视为1处 |
失效链接修复 | 2 | 修复死链 |
格式标准化 | 2 | Markdown 语法修正、代码块语法优化 |
内容补充说明 | 15 | 在现有文档中添加技术细节描述,需满足:100 字以上有效内容;含代码示例或示意图 |
文档结构重组 | 10 | 优化章节逻辑,增加前后文跳转链接 & 导航锚点 |
示例代码丰富 | 10 | 增补实际场景案例,提供文档实用性 |
📅 活动时间
即日起至 2025 年 5 月 30 日
‼️ 参与说明
第一步:加群
加入 钉钉交流群,获取实时任务资讯。
第二步:认领任务(仅限主线任务)
- 在 AntV 文档季 - 任务列表 中查看所有可以领取的任务,请在任务具体 ISSUE 下按格式回复,该任务 assign 给你后即为成功认领~
- 认领回复格式:【GitHub ID + Give it to me】
- eg:【Candicepan Give it to me】
第三步:做任务
成功认领任务后,即可按照任务的要求做具体实现啦。
⚠️ 请在成功认领后 7 天内提交 PR 或有具体的 comment,否则您认领的任务将被自动释放。
第四步:提交 PR
按照任务要求完成后,请以 PR 形式提交要求内容到指定位置。
⚠️ 注意事项:
- PR 标题参考
【OSCP】 + 任务名称
,如【OSCP】docs: 改造点击选中交互文档
,以便快速进入 PR review 阶段。 - PR 与对应任务 ISSUE 进行关联,方式:在 PR 正文中,通过
Fixed #任务 ISSUE 号
即可实现关联,eg:
[TODO]
- PR 提交后,Reviewer 会在 5 个工作日进行验收并给到 Review 意见。若需推进 Review 进度,可在交流群内 @小助手 进行推进。
🎁 活动奖品
Reward 1 数字徽章:活动期间,成功完成 3 个及以上任务(PR merge),恭喜你成为「AntV 开源社区 Contributor」,可获得「AntV 开发者徽章」,速速 pin 到 GitHub 主页~ 查看一些好的案例
<img width="400" src="https://github.com/user-attachments/assets/f7ee05a7-9008-44b1-a778-5f0d35d64222" />
Reward 2 重磅奖品 & 定制周边:我们将于每月 5 日结算积分,随微信公众号推文《文档社区治理月报》一同公示,开发者可自行分配积分兑换实体奖品(当然也可以累积到下一个结算日,兑换更大礼品哦😊)
🤔 活动疑问
如有任何疑问或需要帮助,欢迎在此添加评论。