element/.github/CONTRIBUTING.md
2016-09-20 14:35:44 +08:00

2.1 KiB
Raw Blame History

Element UI Contributing Guide

Hi! 首先感谢你使用 Element UI。

Element UI 是一套为开发者、设计师和产品经理准备的开源组件库,旨在快速搭建页面。它基于 Vue 2.0 开发,并提供了配套的设计资源,充分满足可定制化的需求。

Element UI 的成长离不开大家的支持,如果你愿意为 Element UI 贡献代码或提供建议,请阅读以下内容。

Issue 规范

  • issue 仅用于提交 Bug 或 Feature 以及设计相关的内容,其它内容可能会被直接关闭。如果你在使用时产生了疑问,请到 Slack 或 Gitter 里咨询。

  • 在提交 issue 之前,请搜索相关内容是否已被提出。

  • 请说明 Element UI 和 Vue 的版本号,并提供操作系统和浏览器信息。推荐使用 JSFiddle 生成在线 demo这能够更直观地重现问题。

Pull Request 规范

  • 请先 fork 一份到自己的项目下,不要直接在仓库下建分支。

  • commit 信息要以[组件名]: 描述信息 的形式填写,例如 Button: fix xxx bug

  • 不要提交 lib 里面打包的文件。

  • 执行 npm run dist 后可以正确打包文件。

  • 为了兼容性以及最终打包的文件体积考虑,我们的 babel 只引入了 preset-2015,所以不建议使用 ES2015 的 API例如 Array.prototype.findObject.assign等。如果有需要,请引入第三方的 polyfill。

  • 提交 PR 前请 rebase确保 commit 记录的整洁。

  • 如果是修复 bug请在 PR 中给出描述信息。

  • 合并代码需要两名维护人员参与:一人进行 review 后 approve另一人再次 review通过后即可合并。

开发环境搭建

首先你需要 Node.js 4+ 和 NPM 3+

npm run dev

# open http://localhost:8085

如果国内用户觉得安装慢可以使用 npminstall

npm i npminstall -g
npminstall
npm run dev

# open http://localhost:8085

To build:

npm run dist

代码规范

遵循饿了么前端的 ESLint 即可