sartography
/
bpmn-js
mirror of https://github.com/sartography/bpmn-js.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore(CONTRIBUTING): add ES code style hint

This commit is contained in:
Philipp Fromme 2018-06-07 13:40:43 +02:00
parent 4ade805f3d
commit 8bb34dacb2
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -82,6 +82,16 @@ For details consult our in depth [setup guide](https://github.com/bpmn-io/bpmn-j
Create a [pull request](#creating-a-pull-request) if you would like to have an in-depth discussion about some piece of code. Create a [pull request](#creating-a-pull-request) if you would like to have an in-depth discussion about some piece of code.
### Code Style
In addition to our automatically enforced [lint rules](https://github.com/bpmn-io/eslint-plugin-bpmn-io), please adhere to the following conventions:
* Use modules (`import` / `export (default)`)
* __Do NOT__ use ES language constructs (`class`, `const`, ...) in sources
__Rationale:__ People should be able to consume parts of the library with an ES module aware bundler such as [Webpack](https://webpack.js.org/) or [Rollup](https://rollupjs.org) without the need to use a transpiler such as [Babel](https://babeljs.io/).
### Creating a Pull Request ### Creating a Pull Request
We use pull requests for feature additions and bug fixes. If you are not yet familiar on how to create a pull request, [read this great guide](https://gun.io/blog/how-to-github-fork-branch-and-pull-request). We use pull requests for feature additions and bug fixes. If you are not yet familiar on how to create a pull request, [read this great guide](https://gun.io/blog/how-to-github-fork-branch-and-pull-request).
@ -101,4 +111,4 @@ Some things that make it easier for us to accept your pull requests
We'd be glad to assist you if you do not get these things right in the first place. We'd be glad to assist you if you do not get these things right in the first place.
:heart: from the bpmn.io team. :heart: from the bpmn.io team.