很多人在使用开源软件时,因为「不擅长」提问,给开源作者和自己都带来了很多困扰,本文结合 LeanCloud 工程师曾分享的「社区发帖规范」为大家分享一些如何提问的小经验,帮助大家在遇到问题时能够更快地得到解决。
提问前
在与开源作者联系前,我们可以尝试以下方式:
- 阅读开源项目开发文档
- 在常见问题(FAQ)中寻找答案
- 尝试互联网搜索关键词寻找解决方法
在遇到问题时我们可以先通过查询文档尝试解决。一般来说,开源软件的作者都会写一份文档来帮助使用者。在使用开源软件的过程中,部分问题能够在文档中找到答案,如果找不到,我们还可以在 Stack Overflow (特别是比较流行的开源软件)以及这个开源软件在 github 仓库的 issue(如果这个开源软件在 github 有仓库)中试一试。
在文档内容过多时,还可以尝试使用搜索关键词快速找到对应内容。
提问规范
首先我们应该写一个好的标题,尽量用一句话描述清楚问题,并标明所使用的语言、平台。
正确示例:
- 小程序真机上传数据时,控制台存储中显示的 Class 表名被压缩为单个字母。
- 配置 download 合法域名时显示「该域名因违规被禁止设置。」
错误标题:
- 救命,突然就运行不了了
- 这两天也有人反馈同样的问题,还是不行的
除了描述清楚问题外,最好还能够提供一些更加详细的信息,这些可以帮助原作者更快定位问题,为你提出解决方案。
- 仔细清楚地描述问题,包含前因后果
- 完整的复现代码
- 提供如硬件设备、操作系统、软件版本、网络等环境信息
注意:
在提问涉及代码部分时,注意不要使用图片来展示代码,因为没有人会照着图片手敲代码。
社交礼仪
开源软件作者通常没有义务免费帮我们解决问题,所以在寻求帮助时,说明来意,并使用「请」、「谢谢」等礼貌用语,以感谢作者们无偿花时间帮助我们,友好礼貌的社交方式也会增加我们得到有用回复的机会。
最后,希望大家看完这篇内容后都能够学会如何更好地解决问题,开源项目的用户和作者之间不是甲方和乙方的关系,碰到问题时更多应该抱着「一起合作来解决这个问题」的心态,共同的输入,才会出现更多优秀的开源项目。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。