logo_gitee_light_with_domain_name.png

LinkWeChat 是一个开源且免费的项目，这意味着开源社区中的任何开发者都可以为 LinkWeChat 的开发及进步贡献自己的力量。考虑到改善国内开源环境，目前 LinkWeChat 项目的所有源码仅托管在 Gitee 平台，所以仅接受在此开源平台上进行代码贡献。

我们非常欢迎有更多热爱技术、热爱开源的朋友加入到 LinkWeChat 的开发中来，你们为 LinkWeChat 所做的任何贡献都会被永久记录在 LinkWeChat 的贡献列表中。

参与方式

如果你也希望加入 LinkWeChat 的开发，你可以尝试：

  • 添加开发团队微信 sxjiangdongqin ，参与主功能的开发
  • 关注 Gitee 仓库评论及 Issues 动态，帮助需要帮助的小伙伴
  • 对于 Issues 动态或线上的 Bug 可以以 Pull Request 的形式提交
  • 系统功能/模块单元测试

当然随着项目的成长和生态的完善，我们会逐步开放更多的参与方式，比如：

  • 独立开发营销插件，参与插件平台建设
  • 参与 WiKi 文档的撰写
  • …

贡献流程

  1. 在参与开源贡献之前，你需要了解本项目的分支：
分支名称 分支说明 分支类型 分支权限 是否接受 Pull Request
master 主分支 保护分支 有且仅有项目管理员拥有提交、合并等权限 ×
back_end_dev 后端开发分支 常规分支 项目成员均拥有提交权限 √
fron_end_dev 前端开发分支 常规分支 项目成员均拥有提交权限 √
  1. 进入 LinkWeChat 项目主页点击右上角 Fork 按钮，并选中你想要 Fork 的地址再点击确认，此时 LinkWeChat 项目仓库源码被成功 Fork 到你自己的版本库中：

image.png

  1. 在自己的版本库中新建开发分支并对代码做修改，并将修改提交到自己的版本库中；


  1. 在自己的版本库中，创建一个Pull Request。其中源分支选择自己的开发分支，目标分支选择主库的 back_end_dev 或 fron_end_dev 分支（根据自己修改的内容选择前后端分支），点击创建即可提交当前请求。**

image.png
注意：__此处务必填写 Pull Requset 的名称及说明，方便项目管理员查看。

  1. 创建成功后，请耐心等待项目管理员对你的提交内容做对应的审核及测试。

  2. 如果审核通过，那么恭喜你，你的 ID 及贡献将永久记录在 LinkWeChat 开源项目的贡献列表中。如果审核未通过，项目管理员会第一时间联系你，说明未通过原因并愿意协助你进行后续 Pull Request。

但无论如何，我们都很感谢并认真对待每一次的 Pull Request。

我们希望

尽管我们会尽量保证每一次的 Pull Request 都会成为 LinkWeChat 的一部分，但为了保证项目的质量，我们希望每一个贡献者能做到：

  • 所有源码文件、类型、方法都要有详尽的注释
  • 如果涉及逻辑复杂的部分尽量阐述实现思路
  • 个人新增的功能/模块尽量同时提交单元测试
  • 提交 PR 的同时，尽可能详细的描述涉及改动的内容