开源贡献指南 - duxiaoman/AnyMock GitHub Wiki

AnyMock开源贡献指南

本文档作为基本指南来为您指引如何向 AnyMock 进行贡献。如果您发现文档中有错误或缺失的内容,请向我们联系。

准备工作

具备技能

贡献代码前需要先了解 git 工具的使用和 GitHub 网站的使用。

  • git 工具用法可以查看git官方书籍,需要阅读前几章来熟悉。

搭建开发环境

您需要在系统中安装好 JDK 1.8 或以上的版本,并安装好 Maven、Redis、Mysql。您可能还需要一个 IDE 来进行开发。

贡献

GitHub 工作流

下面是开源贡献者常用的工作流(workflow):

  • 将仓库 fork 到自己的 GitHub 下
  • 将 fork 后的仓库 clone 到本地
  • 创建新的分支,在新的分支上进行开发操作(请确保对应的变更都有测试用例或 demo 进行验证)
  • 保持分支与远程 master 分支一致(通过 fetch 和 rebase 操作)
  • 在本地提交变更(注意 commit log 保持简练、规范),注意提交的 email 需要和 GitHub 的 email 保持一致
  • 将提交 push 到 fork 的仓库下