如何贡献代码

感谢小伙伴为black-shop贡献代码

• black-shop自开源以来更新速度较为缓慢，原因也是因为只有@lizibin一人在进行代码维护。我们希望这个项目真心能做起来，为开源贡献一份薄力，我们希望有更多社区的同学加入进来，一起把项目做好。

如何贡献

• 在贡献代码之前，请您稍微花一些时间了解为black-shop贡献代码的流程。我们随时都欢迎任何贡献，无论是简单的错别字修正，BUG 修复还是增加新功能。请踊跃提出问题或发起 PR。我们同样重视文档以及与其它开源项目的整合，欢迎在这方面做出贡献。如果是一个比较复杂的修改，建议先在 Issue 中添加一个 Feature 标识，并简单描述一下设计和修改点。

该怎么入手

• 如果您是初次贡献，可以先从 good first issue 和 help wanted
• 如果您是开源社区的老江湖，请前往TODO LIST 中认领一个比较复杂功能化的任务。
• Fork 仓库，并将其 Clone 到本地
  • 点击本项目右上角的 Fork 图标 将 lizibin/black-shop fork 到自己的空间
  • 将自己账号下的 black-shop 仓库 clone 到本地，例如我的账号的 lizibin，那就是执行 git clone https://github.com/lizibin/black-shop.git 进行 clone 操作。

配置 Github 信息

• 在自己的机器执行 git config --list ，查看 git 的全局用户名和邮箱。
• 检查显示的 user.name 和 user.email 是不是与自己 github 的用户名和邮箱相匹配。

merge 最新代码

• fork 出来的代码后，原仓库 Master 分支可能出现了新的提交，这时候为了避免提交的 PR 和 Master 中的提交出现冲突，需要及时 merge master 分支。
  • 在你本机的 black-shop 目录下，执行 git remote add upstream https://github.com/lizibin/black-shop 将原始仓库地址添加到 remote stream 中
  • 在你本机的 black-shop 目录下，执行 git fetch upstream 将 remote stream fetch 到本地。
  • 在你本机的 black-shop 目录下，执行 git checkout master 切换到 master 分支。
  • 在你本机的 black-shop 目录下，执行 git rebase upstream/master rebase 最新代码。

代码规范

• 本项目严格按照阿里巴巴P3C的开发标准来执行，如不了解，请先行了解一下：https://github.com/alibaba/p3c
• 为了便于设置，本项目引入editorconfig支持，请使用Eclipse的同学在贡献代码前安装相关插件，而IntelliJ IDEA新版本自带支持，如果没有可自行安装插件。eclipse安装edtorconfig，拖拽安装至eclipse之后，重启按Ctrl+shift+F即可格式化代码。
• 请在javaDoc里面新建一个head头，在新建类的时候自动加上，请规范代码和注释。

开发、提交、Push

• 开发自己的功能，开发完毕后提交。

提交PR

• 提交 PR 前，需要 rebase master 分支的代码
• 如果出现冲突，需要先解决冲突。
• 根据 Pull request template 写明修改点和实现的功能，等待 code review 和 合并，成为 black-shop contributor，为更好用的 black-shop 做出贡献。