给开源项目提 Issue 的一点经验:先搜,再写
【摘要】 上周给一个 Agent 项目提了个文档类 Issue,顺利被接受,分享两点心得:一、先搜有没有人提过动手前先翻一遍已有 Issue 列表。我本来找到一个参数缺失问题,一搜发现 12 小时前刚有人提过,差点重复提交。重复 Issue 对维护者是噪音。二、问题描述要"可复现"只说"文档有问题"没用。正确姿势:指出具体位置(README 哪一节、哪一行附近)+ 说明哪里不一致(示例用了 -o 参数...
上周给一个 Agent 项目提了个文档类 Issue,顺利被接受,分享两点心得:
一、先搜有没有人提过
动手前先翻一遍已有 Issue 列表。我本来找到一个参数缺失问题,一搜发现 12 小时前刚有人提过,差点重复提交。重复 Issue 对维护者是噪音。
二、问题描述要"可复现"
只说"文档有问题"没用。正确姿势:指出具体位置(README 哪一节、哪一行附近)+ 说明哪里不一致(示例用了 -o 参数,参数表里没有)+ 建议怎么改。维护者一眼就能看懂,不用来回问。
三、从文档类 Issue 入手
新手别一上来就挑战代码 bug,文档错别字、失效链接、参数表缺失这类问题门槛低、价值实在,是很好的切入点。
【版权声明】本文为华为云社区用户原创内容,未经允许不得转载,如需转载请自行联系原作者进行授权。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱:
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者
评论(0)