贡献指南
我们十分感谢您愿意为这个项目付出宝贵的热情和时间。为了能够让它们产生尽可能多的价值,希望您在提交贡献前,仔细阅读这一份贡献指南。 以下这份列表包含了您可能能够帮到这个项目的事项(不分先后顺序):
- Bug报告
- Bug修复
- 代码质量
- 功能特性(包括新的集成)
- 测试
- 文档
让我们一起让这个项目变得更加实用!
如何贡献代码改动
- 从我们 的仓库Fork出来,并且创建一个名称意义明确的分支
- 最小化PR原则:一个PR里尽量只涉及同一个改动
- 请为你的改动增加或者更新相关测试
- 每一个Commit的Message请简洁明了,一个PR中不要包含过多的Commit
- 在提交PR前,请确保所有的测试通过
- 请确保已经解决了所有合并冲突
- 在Github的UI界面提交一个Pull Request(PR)
Bug报告
如果您要提交一个Bug报告,那么您需要提交一个Issue。
Issue的标题请简要描述这个Bug,而不是简单的“Bug”,或者“There is a bug”。 在Issue的描述中,需要包含Bug的具体信息,包括:
- 这个Bug的表现是什么
- 这个Bug最简单的重现
如果您已经有对这个Bug做出了一定的分析,不妨大胆地写下来。
Bug修复
进一步的,如果您能够修复一个Bug,可以在Github的UI界面提交一个PR。 在这个PR中,您需要关联一个Bug的Issue。 如果没有相关的Issue,需要将Bug的具体信息写在PR的描述里。
除了上面提到的Issue中本来需要的信息之外,PR的描述还需要包含:
- 您是如何分析并找到代码中Bug发生的位置
- 您此次提交中的代码改动做了一件什么样的事情