bpmn-js/.github/CONTRIBUTING.md

How to Contribute

Great to see you! Help us out by filing bugs or feature requests, assisting others in our forums or by contributing improvements.

Table of Contents

• Working with Issues
  • Creating an Issue
  • Helping out
• Contributing Improvements
  • Setting up the Project locally
  • Discussing Code Changes
  • Adhering to the Code Style
  • Adhering to the Unit Test Style
  • Creating a Pull Request

Working with Issues

We use our issue tracker for project communication, discussion and planning.

Helping out

• Share your perspective on issues
• Be helpful and respect others when commenting

Contributing Improvements

Learn how to setup the project locally, make changes and contribute bug fixes and new features through pull requests.

Setting up the Project

The project development runs on top of the diagram-js master branch. The following code snippet sets up both libraries linking diagram-js to bpmn-js.

mkdir bpmn.io
cd bpmn.io

git clone git@github.com:bpmn-io/diagram-js.git
(cd diagram-js && npm i)

git clone git@github.com:bpmn-io/bpmn-js.git
(cd bpmn-js && npm install && npm link ../diagram-js)

// Run the test suite
npm test

// Running the test suite with every file change
TEST_BROWSERS=(Chrome|Firefox|IE) npm run dev

For details consult our in depth setup guide.

Discussing Code Changes

Create a pull request if you would like to have an in-depth discussion about some piece of code.

Adhering to the Code Style

In addition to our automatically enforced lint rules, 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 or Rollup without the need to use a transpiler such as Babel.

Adhering to the Unit Test Style

In order to retrieve a sign-off for your contribution, it needs to be sufficiently and well tested. Please structure your unit tests into given, when and then (ModelerSpec example, ResizeBehaviorSpec example). To increase overall readability and understandability please also leave two empty lines before describe(...), it(...) or setup blocks on the same indentation level (ModelerSpec example, ResizeBehaviorSpec example).

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.

Some things that make it easier for us to accept your pull requests

• The code adheres to our conventions
  • spaces instead of tabs
  • single-quotes
  • ...
• The code is tested
• The npm run all build passes (executes tests + linting)
• The work is combined into a single commit
• The commit messages adhere to the conventional commits guidelines

We'd be glad to assist you if you do not get these things right in the first place.

❤️ from the bpmn.io team.