文档捉虫 | 参与长安链技术文档积分挑战,边学、边用、边得奖
随着长安链在政务、金融、能源等领域不断落地,其面临的操作场景日益复杂,技术文档的知识密度指数级增长。为提升开发者对长安链开源建设的参与感,社区特别策划了“开源探秘·捉虫赢礼”技术文档积分挑战赛!本次活动将邀请广大开发者化身“技术侦探”,一起揪出技术文档中精心设计的隐藏“知识蛀虫”(错误信息),捉虫累计的积分可用于兑换社区的精美礼品和文档贡献者荣誉。同时社区为开发者提供了快捷通道和完整的操作教程。
- 注意:本次活动限长安链2.2.0及以上版本文档。
- 此部分不解答产品或技术相关问题,非文档捉虫活动相关问题移步至:https://git.chainmaker.org.cn/chainmaker/issue/-/issues
积分规则
1. 低错类问题:issue 1 分/个, PR 2 分/个
- 错别字、拼写错误;
- 链接错误异常、文档格式错乱等
- 表述不通顺;
- 版本号不匹配等。
2. 易用性问题:issue 3 分/个, PR 5 分/个
- 关键步骤错误或缺失,无法指导用户完成任务;
- 缺少必要的前提条件、注意事项等;
- 文档内代码格式错误,例如少空格、少引号等;
- 逻辑不清晰,该分类、分项、分步骤等。
3. 正确性问题:issue 5 分/个,PR 8 分/个
- 原理图、架构图等存在错误;
- 关键参数描述错误,无法指导用户完成任务;
- 命令无法完成对应指令。
4. 风险提示类问题:issue 8 分/个,PR 12 分/个
- 对重要数据或系统存在特别风险的操作缺少安全提示。
活动奖励
积分规则
- 活动范围限长安链2.2.0版本及以上文档;
- 设置【文档捉虫活动】标签且获得主办方评论确认的issue和Mr获得积分; 3. 每个 issue 或 PR 请贴上对应问题类型的标签(低错类=P3,易用性=P2,正确性=P1,风险提示类=P0),以方便我们验证和统计您的积分;
- 一个 issue 或 PR 仅提交一个问题,多个问题请不要在一次性提交;
- 同样的问题在不同文档出现,如果多次提交只算一个问题;
- 同一问题多人反馈,按时间排序靠前者为准;
- 以下问题视为无效:
- 问题无法定位
- 问题无法复现
- 问题非首次反馈
- 产品或业务建议
- 其他经社区审核判定无效的情况
Issue提交模板:
- 问题类型:P1/正确性(示例)
- 页面链接:https://docs.chainmaker.org.cn/(示例)
- 问题片段:长安链证书生成工具、区块链浏览器、区块链管理平台等一系列生态工具的后端目前也选择golang作为开发语言(示例)
- 详细描述:此部分填写详细的问题描述
- 解决方案:此部分填写建议的解决方案
- 如有特殊需求可以按照需求调整 选择【文档捉虫】label
提交Mr必读:Mr提交流程及注意事项
见附件,含:一、注册流程;二、创建分支(Fork);三、使用GitLab界面更新文件的MR流程;四、使用Git命令行工具更新文件的MR流程;五、注意事项。 长安链MR提交流程.pdf
名单公布
首批获奖开发者名单6月6日公布在Gitlab活动issue链接,获奖开发者可联系长安链小助手兑换积分并邮寄奖品,奖品统一发放。 获奖或任何其他问题可以联系长安链小助手:ChainMaker2021