很多人在应用开源软件时,因为「不善于」发问,给开源作者和本人都带来了很多困扰,本文联合 LeanCloud 工程师曾分享的「社区发帖标准」为大家分享一些如何发问的小教训,帮忙大家在遇到问题时可能更快地失去解决。
发问前
在与开源作者分割前,咱们能够尝试以下形式:
- 浏览开源我的项目开发文档
- 在常见问题(FAQ)中寻找答案
- 尝试互联网搜寻关键词寻找解决办法
在遇到问题时咱们能够先通过查问文档尝试解决。一般来说,开源软件的作者都会写一份文档来帮忙使用者。在应用开源软件的过程中,局部问题可能在文档中找到答案,如果找不到,咱们还能够在 Stack Overflow(特地是比拟风行的开源软件)以及这个开源软件在 github 仓库的 issue(如果这个开源软件在 github 有仓库)中试一试。
在文档内容过多时,还能够尝试应用搜寻关键词疾速找到对应内容。
发问标准
首先咱们应该写一个好的题目,尽量用一句话形容分明问题,并表明所应用的语言、平台。
正确示例:
- 小程序真机上传数据时,控制台存储中显示的 Class 表名被压缩为单个字母。
- 配置 download 非法域名时显示「该域名因违规被禁止设置。」
谬误题目:
- 救命,忽然就运行不了了
- 这两天也有人反馈同样的问题,还是不行的
除了形容分明问题外,最好还可能提供一些更加具体的信息,这些能够帮忙原作者更快定位问题,为你提出解决方案。
- 认真分明地形容问题,蕴含前因后果
- 残缺的复现代码
- 提供如硬件设施、操作系统、软件版本、网络等环境信息
留神:
在发问波及代码局部时,留神不要应用图片来展现代码,因为没有人会照着图片手敲代码。
社交礼仪
开源软件作者通常没有任务收费帮咱们解决问题,所以在寻求帮忙时,阐明来意,并应用「请」、「谢谢」等礼貌用语,以感激作者们无偿花工夫帮忙咱们,敌对礼貌的社交形式也会减少咱们失去有用回复的机会。
最初,心愿大家看完这篇内容后都可能学会如何更好地解决问题,开源我的项目的用户和作者之间不是甲方和乙方的关系,碰到问题时更多应该抱着「一起单干来解决这个问题」的心态,独特的输出,才会呈现更多优良的开源我的项目。