knife4j
knife4j copied to clipboard
xiaoymin
Knife4j 提ISSUES必看 [置顶]
虽然建立了QQ交流群,但是很多没有加群的朋友会通过ISSUES来反馈问题,提ISSUES本身是一个很好的技术习惯，这有助于帮助我能很好的定位问题所在,但因为我并不是实时关注,所以经常在我处理issues的时候，看到很多朋友提的问题却也无从着手，写下一些建议,希望提ISSUES的朋友能在提的时候都有涉及到：
1、Knife4j和springfox-swagger的版本号，必要情况下SpringBoot等相关的版本也贴上,这个尤为重要,很多低版本出现的问题有可能我在新发布的版本中已经解决了,每个版本都有更新日志,可以参考这篇文档：https://doc.xiaominfo.com/changelog/
2、提ISSUES时贴图、贴代码,代码不用贴逻辑，只需要贴接口层即可,还有相关的实体类(如果有涉及的话)，有些问题可能是需要一连串的动作，希望能贴整个顺序图，帮助我复现Bug，这些信息有助于我快速定位问题,省去了来回沟通的成本,提高大家的效率
3、在QQ交流群沟通的朋友我也希望能通过提ISSUE来记录下我们沟通的过程,我并非实时处理此问题，这让我集中再处理issues的时候有助于拉回我们彼此沟通时的场景，最终在新版本解决问题
4、一句简单的话不足以概括所有的信息一律当无效关闭处理
希望大家提issues的时候多一些信息,也省去大家交流的时间成本，提个问题，也不详细，我还得问版本号 之类的，一来一回估计一周也过去了，浪费大家精力，我也不是实时盯着这个开源项目的，我也有工作要做的。
提issues信息不全的(我看不明白,特别是那种我还要问版本号之类的)我会直接关闭处理。请大家理解
