TiDB 文档挑战赛 2024 来了！
活动背景
文档是开源软件项目的关键组成部分。清晰、准确、易于理解的文档可以让用户轻松上手使用产品，并在产品使用的过程中通过文档自助解决遇到的大多数问题。
为了给大家带来更好的文档使用体验，我们宣布，首届 TiDB 文档挑战赛 (TiDB Docs Dash) 将于 2024 年 1 月 9 日 - 12 日进行。同时，我们也希望将借此机会将 TiDB 社区成员聚集到一起，为大家带来一次有趣的协作体验。
通过此次活动，你将有机会结识其他社区成员，与大家一起共同改进 TiDB 和 TiDB Cloud 文档。
这篇帖子详细介绍了举办此次活动的初心和想法，活动运作方式等，我们诚挚地邀请各位 TiDBer 参与本次活动，一起优化文档，帮助更多 TiDBer！ 
最新活动攻略 ：
活动时间
在此次活动中，我们为大家准备了各种类型的文档小任务，包含“调试”文档、完善文档、翻译文档、解决文档问题等。
-
任务领取时间：即日起 — 1 月 12 日 16:00
-
任务链接：2024 TiDB Docs Dash Issue List | 2024 TiDB 文档挑战赛任务列表 · GitHub
-
领取方式：点开感兴趣的任务，在任务的 issue 或者 pull request (PR) 上通过在 comment 中添加
/assign命令认领任务。
-
-
任务提交时间：1 月 9 日 16:00 — 1 月 12 日 16:00（北京时间）
- 注意：需要在此时间段内提交 PR 或 issue 才可获得活动奖励。
有关活动参与的详细信息请参见后面的 FAQ 部分。
活动奖励
参与奖：
通过以下任一形式参与到活动中，均可获得 TiDB Docs Dash 活动定制徽章（可添加至 GitHub 个人主页 ）和社区徽章（活动结束后发放！）
- 提交文档 PR
- 提交文档 issue
- 在文档 issue 上添加有价值评论
徽章：
PR 被合并
-
社区积分：首个 PR 被合并可获得 300 积分&经验值，之后每多提交一个 PR 被合并就多奖励 50 积分&经验值，最高可获得 2000 积分&经验值。
-
未注册社区的小伙伴，可以点击这里进行注册，活动后下发的积分可以直接兑换社区周边。
活动后我们会在 7 个工作日内发放社区积分，因为 GitHub ID 和社区昵称不一致（对的上的我们会直接发放积分），如有遗漏，请及时联系工作人员。
计分 Top 1-5 名奖品：
我们为计分在前五名的参与者准备了精美的奖品。
计分规则详细请看下方介绍
| 奖项 | 奖品 |
|---|---|
| 第一名 | Bose 蓝牙降噪耳机 |
| 第二名 | 500元京东礼品卡 |
| 第三名 | TiDB 定制机械键盘 |
| 第四名 | TiDB 定制周边礼包 |
| 第五名 | TiDB 定制周边礼包 |
第一名 Bose 蓝牙降噪耳机
徽章：
第二名 500 元京东礼品卡
徽章：
第三名 TiDB 定制机械键盘
徽章：
第四名 TiDB 定制周边礼包
徽章：
第五名 TiDB 定制周边礼包
徽章：
参与本帖留言留下你的 GitHub ID 即可参与抽奖
留下你的 GitHub ID，也方便后续积分发放
抽奖奖励：
社区双肩包 二选一
抽奖截止时间：
2024 年 1 月 12 日 16:00
活动 FAQ
-
参与有什么要求吗？
- 参与无需注册，但是你需要拥有 GitHub 帐号并在提 pull request (PR) 时签署贡献者许可协议 (CLA)。
-
TiDB 文档源文件在哪里？
-
我如何参与？
-
方式一：提 PR 完成任务列表中的任务 （推荐）
-
在活动任务列表中，选择感兴趣的任务并点开该任务。
-
在任务的 issue 或者 pull request (PR) 上，通过在 comment 中添加
/assign命令认领任务。 -
提交 PR 解决任务，在 PR 描述中提供 PR 相关的 issue 链接，在 PR comment 中通过添加
/label 2024-tidb-docs-dash命令标识 PR，并处理 PR 收到的评审建议。
-
-
方式二：提 issue 指出文档问题，包含但不限于文档准确性、完整性、清晰性等问题。
-
方式三：提 PR 解决任何文档问题。
-
方式四：为活动任务列表中的 issue 提供有价值的评论。
-
-
有关于此次贡献活动的其他参考资料吗？
建议在参与活动前阅读这些材料：
-
如何在此活动开始之前和期间获得帮助？
- 如有疑问，欢迎大家在本帖评论区提出活动相关问题，我们会帮助您解决～
Top 1-5 名活动计分说明
以下表格列出了活动计分的基本计算规则。在活动之前，我们可能会对这些规则进行一些微调（例如，奖励分），但更改应该很小。总体而言，处理本次活动 GitHub 任务列表中的任务将比处理其他任务获得更高的积分，提交 PR 解决问题将比在 issue 上提供建议获得更高的积分。
对在活动任务列表中的 issue 或 PR ，计分规则如下：
| 贡献 | 计分 | 备注 |
|---|---|---|
| 在 1 月 9 日 16:00 - 12 日 16:00 期间提交 PR | 4 | 每提交 1 个文档 PR 获得 4 分 |
| 1 月 26 日前所提 PR 被合并 | 10 | 每个 PR 被合并后获得 10 分 |
| 其他类型贡献（例如：在现有的 GitHub issue 上分享解决问题的想法和建议等） | 2 | 每个有价值的评论获得 2 分。我们将会评估收到的贡献。评论质量不佳可能不予积分。 |
对不在活动任务列表的 issue 或 PR ，计分规则如下：
| 贡献类型 | 计分 | 备注 |
|---|---|---|
| 在 1 月 9 日 16:00 - 12 日 16:00 期间提交 PR | 2 | 每提交 1 个文档 PR 获得 2 分 |
| 1 月 26 日前所提 PR 被合并 | 5 | 每个 PR 被合并后获得 5 分 |
| 其他贡献类型（例如，创建 GitHub issue 反馈文档问题，或在现有的 GitHub issue 上分享解决问题的想法和建议等） | 1 | 每个有价值的评论获得 1 分。我们将会评估收到的贡献。如质量不佳可能不予积分。 |
说明：对于贡献突出的 PR，我们还将额外给予奖励分。
2024 TiDB 文档挑战赛交流群
如有太多广告进入，我们将采用邀请制进群，进群请联系 TiDB Robot 微信哈（tidbai）
奖项预计公布时间
2024 年 2 月初，敬请期待！
