Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 2.1 KB

CONTRIBUTE.md

File metadata and controls

44 lines (28 loc) · 2.1 KB

How to contribute

We love you to contribute to this project by filing bugs, helping others on the issue tracker, by contributing features/bug fixes through pull requests.

Creating issues

We use our issue tracker for project communication. When using the issue tracker:

  • Be descriptive when creating an issue (what, where, when and how does a problem pop up)?
  • Attach steps to reproduce (if applicable)
  • Attach code samples, configuration options or stack traces that may indicate a problem
  • Be helpful and respect others when commenting

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

Setting up the project locally

The project is using Maven 3 as build tool.
To build the project by yourself, g oto our cmd line and enter mvn clean install on the root of the checked out project.

Hint for eclipse users: clone the repo as camunda-spring-boot-starter-root

Creating pull requests

We use pull requests for feature discussion 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:

We use http://editorconfig.org in this project. If your IDE supports it, you do not have to add any additional configuration. If you are not able to use this (unfortunately this applies to all eclipse based IDEs so far), make sure you use the eclipse formatter.

  • The code adheres to our conventions
    • spaces instead of tabs
    • single-quotes
    • ...
    • see the .editorconfig file
  • The code is tested
  • The mvn clean install build passes including tests
  • The work is combined into a single commit

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