Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 1.89 KB

CONTRIBUTING.MD

File metadata and controls

57 lines (35 loc) · 1.89 KB
Raw

Contributing

🎉 Thank you for taking the time to contribute! 👍

How Can I Contribute?

Reporting Bugs

If you found a bug or unexpected behavior in the SDK or one of the processes then create a new issue. Before creating an issue, make sure that there is no issue yet. Any information you provide on the issue would be helpful to solve it.

Suggesting Enhancements

If you have an idea of how to improve the SDK, one of the processes, or something else in the project then create a new issue. Describe your idea and the motivation behind it. To speed up the process, think about providing a pull request.

Improving Documentation

If you see a way to improve the documentation, for example, by providing additional or missing information, then open a new pull request with your changes.

Sharing your Examples

Did you model a cool process or useful process block? Let's open a pull request and share your example.

Running integration tests

You can run the integration tests in the project with Maven.

In the directory tests:

Run the tests with

mvn clean test

Styleguides

Git Commit Messages

Commit messages should follow the Conventional Commits format.

For example:

feat(sdk): Improve error handling

Handle all 4xx errors and throw a BPMN error with the related error name.

Available commit types:

  • feat - enhancements, new features
  • fix - bug fixes
  • refactor - non-behavior changes
  • test - only changes in tests
  • docs - changes in the documentation, readme, etc.
  • style - apply code styles
  • build - changes to the build (e.g. to Maven's pom.xml)
  • ci - changes to the CI (e.g. to GitHub related configs)