mirror of
https://gitee.com/ElemeFE/element.git
synced 2024-11-30 03:07:36 +08:00
Merge pull request #88 from Leopoldthecoder/master
update contributing guide
This commit is contained in:
commit
380a2f7149
26
.github/CONTRIBUTING.md
vendored
26
.github/CONTRIBUTING.md
vendored
@ -1,28 +1,34 @@
|
||||
# Element Contributing Guide
|
||||
# Element UI Contributing Guide
|
||||
|
||||
Hi! 首先感谢你使用 Element UI。这是一个为开发者、设计师和产品经理准备的一套能让你快速搭建页面的基于 Vue 2.0 的组件库,同时我们还提供了相关设计资源供设计师使用。如果你考虑为 Element 贡献代码的话,请确保阅读下面内容。
|
||||
Hi! 首先感谢你使用 Element UI。
|
||||
|
||||
Element UI 是一套为开发者、设计师和产品经理准备的开源组件库,旨在快速搭建页面。它基于 Vue 2.0 开发,并提供了配套的设计资源,充分满足可定制化的需求。
|
||||
|
||||
Element UI 的成长离不开大家的支持,如果你愿意为 Element UI 贡献代码或提供建议,请阅读以下内容。
|
||||
|
||||
## Issue 规范
|
||||
- issue 仅仅用来提交 Bug 或 Feature 以及设计相关的内容。如果只是简单的问题,请到 Slack 或 [Gitter](https://gitter.im/ElemeFE/element) 里咨询,并且我们会直接关掉。
|
||||
- issue 仅用于提交 Bug 或 Feature 以及设计相关的内容,其它内容可能会被直接关闭。如果你在使用时产生了疑问,请到 Slack 或 [Gitter](https://gitter.im/ElemeFE/element) 里咨询。
|
||||
|
||||
- 提交 issue 前请搜索下是否有同样的问题已经被 fix 或者回复过了。
|
||||
- 在提交 issue 之前,请搜索相关内容是否已被提出。
|
||||
|
||||
- 请确保指明了 Element、Vue 的版本号,以及操作系统和浏览器的版本,最好能提供在线演示的链接。
|
||||
- 请说明 Element UI 和 Vue 的版本号,并提供操作系统和浏览器信息。推荐使用 [JSFiddle](https://jsfiddle.net/) 生成在线 demo,这能够更直观地重现问题。
|
||||
|
||||
## Pull Request 规范
|
||||
- 请先 fork 一份到自己的项目下,不要直接在仓库下建分支。
|
||||
|
||||
- commit 信息要以`[组件名]: 描述信息` 的形式填写,例如 `Button: fix xxx bug`。
|
||||
|
||||
- 提交前**不要提交** `lib` 里面打包的文件。
|
||||
- **不要提交** `lib` 里面打包的文件。
|
||||
|
||||
- 执行 `npm run dist` 后可以正确打包文件。
|
||||
|
||||
- 为了兼容和最终打包的文件体积考虑,我们的 babel 只引入了 `preset-2015`,所以不建议使用 ES2015 的 API,例如 `Array.prototype.find`、`Object.assign`等。如果有需要,请引入第三方的 polyfill。
|
||||
- 为了兼容性以及最终打包的文件体积考虑,我们的 babel 只引入了 `preset-2015`,所以不建议使用 ES2015 的 API,例如 `Array.prototype.find`、`Object.assign`等。如果有需要,请引入第三方的 polyfill。
|
||||
|
||||
- 如果是修复 bug,请给出描述信息在 PR 里。
|
||||
- 提交 PR 前请 rebase,确保 commit 记录的整洁。
|
||||
|
||||
- 合并代码需要两名维护人员参与:一人进行 review 后留言 lgtm,另一人再次 review,通过后即可合并。
|
||||
- 如果是修复 bug,请在 PR 中给出描述信息。
|
||||
|
||||
- 合并代码需要两名维护人员参与:一人进行 review 后 approve,另一人再次 review,通过后即可合并。
|
||||
|
||||
## 开发环境搭建
|
||||
首先你需要 Node.js 4+ 和 NPM 3+
|
||||
@ -48,4 +54,4 @@ npm run dist
|
||||
```
|
||||
|
||||
## 代码规范
|
||||
遵循 lint 即可
|
||||
遵循饿了么前端的 [ESLint](https://github.com/ElemeFE/eslint-config-elemefe) 即可
|
||||
|
2
.github/ISSUE_TEMPLATE.md
vendored
2
.github/ISSUE_TEMPLATE.md
vendored
@ -2,7 +2,7 @@
|
||||
Thank you for contributing! Please carefully read the following before opening your issue.
|
||||
-->
|
||||
|
||||
### Element version
|
||||
### ElementUI version
|
||||
<!-- 1.0.0-rc.2 -->
|
||||
|
||||
### OS/Browers version
|
||||
|
@ -23,14 +23,15 @@
|
||||
}
|
||||
th {
|
||||
text-align: left;
|
||||
border-top: 1px solid #eaeefb;
|
||||
background-color: #EFF2F7;
|
||||
}
|
||||
td, th {
|
||||
border-bottom: 1px solid #eaeefb;
|
||||
padding: 10px 0;
|
||||
}
|
||||
th {
|
||||
border-top: 1px solid #eaeefb;
|
||||
background-color: #EFF2F7;
|
||||
th:first-child, td:first-child {
|
||||
padding-left: 10px;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -4,7 +4,6 @@
|
||||
|
||||
.content {
|
||||
padding-left: 25px;
|
||||
border-left: 1px solid #eaeefa;
|
||||
margin-left: -1px;
|
||||
|
||||
h3 {
|
||||
|
Loading…
Reference in New Issue
Block a user