Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

deps: Update form-js to 0.13.1 #168

Merged
merged 1 commit into from
Apr 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 42 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,66 +7,86 @@
### Reporting bugs

If you found a bug or an unexpected behevior then please create
a [new issue](https://github.com/camunda-community-hub/zeebe-play/issues). Before creating an issue, make sure
a [new issue](https://github.com/camunda-community-hub/zeebe-play/issues). Before creating an issue,
make sure
that there is no issue yet. Any information you provide in the issue, helps to solve it.

### Suggesting enhancements

If you have an idea how to improve the project then please create
a [new issue](https://github.com/camunda-community-hub/zeebe-play/issues). Describe your idea and the
a [new issue](https://github.com/camunda-community-hub/zeebe-play/issues). Describe your idea and
the
motivation behind it.

Please note that this is a community-driven project. The maintainers may have not much time to implement new features if
Please note that this is a community-driven project. The maintainers may have not much time to
implement new features if
they don't benefit directly from it. So, think about providing a pull request.

### Providing a pull requests

You want to provide a bug fix or an improvement? Great! :tada:

Before opening a pull request, make sure that there is a related issue. The issue helps to confirm that the behavior is
Before opening a pull request, make sure that there is a related issue. The issue helps to confirm
that the behavior is
unexpected, or the idea of the improvement is valid. (Following the rule "Talk, then code")

In order to verify that you don't break anything, you should build the whole project and run all tests. This also apply
In order to verify that you don't break anything, you should build the whole project and run all
tests. This also apply
the code formatting.

Please note that this is a community-driven project. The maintainers may have no time to review your pull request
Please note that this is a community-driven project. The maintainers may have no time to review your
pull request
immediately. Stay patient!

## Hints for developers

For development, ZeeQS's GraphQL API can be inspected by using http://localhost:8080/graphiql.
For development, ZeeQS's GraphQL API can be inspected by using http://localhost:8080/graphiql.

### Architecture

![architecture](assets/zeebe-play-architecture.png)

### Contributing to the frontend

The frontend of Zeebe-Play is based on HTML and (plain) JavaScript.
The frontend of Zeebe-Play is based on HTML and (plain) JavaScript.

The following libraries are used:

- [Bootstrap](https://getbootstrap.com/)
- [Bootstrap icons](https://icons.getbootstrap.com/)
- [jQuery](https://jquery.com/)
- [Thymeleaf](https://www.thymeleaf.org/) (for splitting the HTML page/fragments)
- [bpmn-js](https://github.com/bpmn-io/bpmn-js)
- [bpmn-font](https://github.com/bpmn-io/bpmn-font)
- [bpmn-js](https://github.com/bpmn-io/bpmn-js)
- [bpmn-font](https://github.com/bpmn-io/bpmn-font)

Enhancing the user interface (UI) or the user experience (UX) are good areas for contributions. But also improvements of the JavaScript code are welcome. Since I don't have much experience in this area, it might look odd and not following best practices.
Enhancing the user interface (UI) or the user experience (UX) are good areas for contributions. But
also improvements of the JavaScript code are welcome. Since I don't have much experience in this
area, it might look odd and not following best practices.

### Contributing to the backend
#### Update the frontent libraries

The backend of Zeebe-Play is written in [Kotlin](https://kotlinlang.org/) and based on the [Spring Boot](https://spring.io/projects/spring-boot/) framework.
- BPMN-JS: download `camunda-cloud-navigated-viewer.production.min.js`
from https://unpkg.com/browse/camunda-bpmn-js/dist/
- DMN-JS: download `dmn-navigated-viewer.production.min.js`
from https://unpkg.com/browse/dmn-js/dist/
- Form-JS: download `form-viewer.umd.js` from https://unpkg.com/browse/@bpmn-io/form-js/dist/

Currently, it contains only the REST command API and a few services. The other parts are included from libraries, like the following:
### Contributing to the backend

- [EZE](https://github.com/camunda-community-hub/eze), runs processes on an embedded Zeebe engine
The backend of Zeebe-Play is written in [Kotlin](https://kotlinlang.org/) and based on
the [Spring Boot](https://spring.io/projects/spring-boot/) framework.

Currently, it contains only the REST command API and a few services. The other parts are included
from libraries, like the following:

- [EZE](https://github.com/camunda-community-hub/eze), runs processes on an embedded Zeebe engine
- [ZeeQS](https://github.com/camunda-community-hub/zeeqs), exposes Zeebe's data as a GraphQL API
- [Zeebe Hazelcast Exporter](https://github.com/camunda-community-hub/zeebe-hazelcast-exporter), transmits Zeebe's data via Hazelcast
- [Zeebe Exporter Protobuf](https://github.com/camunda-community-hub/zeebe-exporter-protobuf), serializes Zeebe's data to Protobuf
- [Zeebe Hazelcast Exporter](https://github.com/camunda-community-hub/zeebe-hazelcast-exporter),
transmits Zeebe's data via Hazelcast
- [Zeebe Exporter Protobuf](https://github.com/camunda-community-hub/zeebe-exporter-protobuf),
serializes Zeebe's data to Protobuf

Contributions in the dependent libraries are very welcome and are directly useful for Zeebe-Play.
Contributions in the dependent libraries are very welcome and are directly useful for Zeebe-Play.

## Building the project from source

Expand All @@ -90,11 +110,13 @@ mvn clean install

### Formatting the source code

The Java code should be formatted using [Google's Java Format](https://github.com/google/google-java-format).
The Java code should be formatted
using [Google's Java Format](https://github.com/google/google-java-format).

### Git commit messages

Commit messages should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) format.
Commit messages should follow
the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) format.

For example:

Expand Down
Loading