Fetching contributors…
Cannot retrieve contributors at this time
51 lines (34 sloc) 1.82 KB

Contributing to Zeebe

Most Zeebe source files are made available under the Apache License, Version 2.0 except for the broker-core component. The broker-core source files are made available under the terms of the GNU Affero General Public License (GNU AGPLv3). See individual source files for details.

If you would like to contribute something, or simply want to hack on the code this document should help you get started.

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to

Using GitHub issues

We use GitHub issues to track bugs and enhancements. If you have a general usage question please ask on the forum or slack channel.

If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible. Ideally, that would include a small sample project that reproduces the problem.

Building zb from Source

Building the Documentation

The documentation is located under docs/.

In order to build the documentation you need the mdbook utilitity.

The binaries can be downloaded from the github release page.

In order to use mdbook you need to put it into your path. After this you can simply type

cd docs/
mdbook serve

This will assemble the documentation from the sources and serve it under http://localhost:3000.