From 8bb34dacb2fabbc284d99c81dd022c189fe9fdcc Mon Sep 17 00:00:00 2001 From: Philipp Fromme Date: Thu, 7 Jun 2018 13:40:43 +0200 Subject: [PATCH] chore(CONTRIBUTING): add ES code style hint --- CONTRIBUTING.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c2db2698..99dd2db8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. +### 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 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. -:heart: from the bpmn.io team. \ No newline at end of file +:heart: from the bpmn.io team.