Skip to content

Latest commit

 

History

History
59 lines (30 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

59 lines (30 loc) · 3.02 KB

贡献指南

这篇指南会指导你如何为 easyWeCom 贡献一份自己的力量,请在提 issue 或者 pull request 之前仔细阅读一遍这篇指南。

行为准则

我们有一份行为准则,希望所有的贡献者都能遵守,请花时间阅读一遍全文以确保你能明白哪些是可以做的,哪些是不可以做的。

开发流程

我们所有的工作都会放在 GitHub上。不管是核心团队的成员还是外部贡献者的 pull request 都需要经过同样流程的 review,也非常欢迎各位开发者 Review 并参与讨论。

参考资料: 代码规范与审核流程

分支管理

我们的主要维护三个分支 :master fix feature 。

如果你要修一个 bug:请基于 fix 分支开发,发起 pull request 到 fix ;

如果你要增加一个新功能或者对现有的功能进行优化:那么请基于 feature 分支开发,并发起 pull request 到 feature ;

我们每月定期合并 fix feature 到 master ,并发布一个正式版本。

Bugs

我们使用 GitHub Issues来做 bug 追踪。 如果你想要你发现的 bug 被快速解决,最好的办法就是使用这个 模板 提供bug相关信息,为了bug能够快速被解决,我们希望 信息提供得尽可能完整

在反馈 bug 之前,需要经过以下两个流程:

  1. 搜索已有的issue,确认该 bug 无人反馈,避免相同的 bug 多次反馈,重复处理。

  2. 阅读我们的 常见问题解答,确认不是由于配置问题导致功能使用异常。

新增功能

如果你有改进我们现有的功能或者新增功能的想法,我们同样推荐你使用我们提供的 模板 来新建一个添加新功能的 issue 。

在新建 issue 之前,需要先搜索已有的issue,确认这是首次提出的优化建议或新增功能,避免出现两个或多个相同描述的issue 。

Pull Request

请按照下面的步骤发送 Pull Request :

  1. 基于 正确的分支 创建开发分支。

  2. 按照编码规范进行开发。

  3. 提交之前使用 SonarLint 或其他代码检查工具对当前模块代码进行检查,并修改完所有的异常提示。

  4. 提交代码,请求合并到对应分支。

参与讨论

可以到 easyWeCom 的 Discussions 板块参与讨论。

可以加入我们的企业微信群,与我们的技术人员和其他贡献者一起讨论。