Great to see you! Help us out by filing bugs or feature requests, assisting others in our forums or by contributing improvements.
We use our issue tracker for project communication, discussion and planning.
- Share your perspective on issues
- Be helpful and respect others when commenting
Learn how to setup the project locally, make changes and contribute bug fixes and new features through pull requests.
The project consists of two subpackages: the client and the app. Test suites for both of them can be run separately.
git clone [email protected]:camunda/camunda-modeler.git
cd camunda-modeler && npm i
// Run the test suite for both packages sequentially
npm test
// Run in dev mode
npm start
// Run tests, linter and build distro
npm run all
Create a pull request if you would like to have an in-depth discussion about some piece of code.
In addition to our automatically enforced lint rules, please adhere to the following conventions:
- Use modules for client (
import/export (default)) - Use CommonJS for app (
require/module.exports)
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 allbuild 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.