CONTRIBUTING.md

贡献指南

这篇指南会指导你如何为 Remax 贡献一份自己的力量，请在你要提 issue 或者 pull request 之前花几分钟来阅读一遍这篇指南。

参与者公约

我们有一份社区的《参与者公约》，希望所有的参与者都能遵守，请花时间阅读一遍全文以确保你能明白哪些是可以做的，哪些是不可以做的。

透明的开发

我们所有的工作都会放在 GitHub 上。不管是核心团队的成员还是外部贡献者的 pull request 都需要经过同样流程的 review。

分支管理

目前我们所有的开发都在 master 分支上进行，我们会尽力保证 master 上的代码稳定。所有在 master 上提交的代码必须是向下兼容的，可以新增功能，但不允许有破坏性的修改。

Bugs

我们使用 GitHub Issues 来管理 bug。 如果你想要你发现的 bug 被快速解决，最好的办法就是给我们提一个带有可重现仓库的 issue。

所有的 bug 会有 bug 标记，如果你想找一个容易上手的 bug 来修复，可以查看标记为 good first issue 的 issue。

在你报告一个 bug 之前，请先确保已经搜索过已有的 issues。

开发

在开始之前推荐你先了解一下《Remax 实现原理》

构建项目

推荐用 yarn

$ git clone [email protected]:remaxjs/remax.git
$ cd remax
$ yarn
$ yarn watch

调试开发包

$ cd path/to/remax/packages/remax
$ yarn link
$ cd path/to/remax/packages/@remax/cli
$ yarn link
$ git clone [email protected]:remaxjs/examples.git remax-examples
$ cd remax-examples/ali # 找一个你要调试的例子
$ yarn link remax @remax/cli
$ yarn dev

然后用对应小程序的 IDE 打开 dist 目录就可以调试了。

运行测试

$ yarn test