Skip to content

Latest commit

 

History

History
233 lines (180 loc) · 10.3 KB

CONTRIBUTING.md

File metadata and controls

233 lines (180 loc) · 10.3 KB
Raw

Contributing to ZDB

Copied from https://github.com/camunda-cloud/zeebe/blob/main/CONTRIBUTING.md

Build from source

ZDB is a multi-module maven project. Partly written in Kotlin. To build all components, run the command: mvn clean install -DskipTests in the root folder.

The resulting ZDB cli can be found in the folder cli/target, i.e.

cli/target/cli-X.Y.Z-SNAPSHOT-jar-with-dependencies.jar

This is a small overview of the contents of the different modules:

  • cli contains the cli facade
  • backend contains the backend and the general logic of zdb

Report issues or contact developers

ZDB uses GitHub issues to organize the development process. If you want to report a bug or request a new feature feel free to open a new issue on GitHub.

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.

If you have a general usage question please ask on the forum or slack channel.

GitHub Issue Guidelines

Every issue should have a meaningful name and a description which either describes:

  • a new feature with details about the use case the feature would solve or improve
  • a problem, how we can reproduce it and what would be the expected behavior
  • a change and the intention how this would improve the system

Starting on an issue

The main branch contains the current in-development state of the project. To work on an issue, follow the following steps:

  1. Check that a GitHub issue exists for the task you want to work on. If one does not, create one. Refer to the issue guidelines.

  2. Checkout the main branch and pull the latest changes.

    git checkout main
git pull

  3. Create a new branch with the naming scheme issueId-description.

    git checkout -b 123-adding-bpel-support`

  4. Follow the Google Java Format and Zeebe Code Style while coding.

  5. Implement the required changes on your branch and regularly push your changes to the origin so that the CI can run. Code formatting, style and license header are fixed automatically by running maven. Checkstyle violations have to be fixed manually.

    git commit -am 'feat(broker): bpel support'
git push -u origin 123-adding-bpel-support

  6. If you think you finished the issue please prepare the branch for reviewing. Please consider our pull requests and code reviews guide, before requesting a review. In general the commits should be squashed into meaningful commits with a helpful message. This means cleanup/fix etc commits should be squashed into the related commit. If you made refactorings it would be best if they are split up into another commit. Rule of thumb is that you should think about how a reviewer can best understand your changes. Please follow the commit message guidelines.

  7. After finishing up the squashing force push your changes to your branch.

    git push --force-with-lease

Creating a pull request

Before opening your first pull request, please have a look at this guide.

  1. To start the review process create a new pull request on GitHub from your branch to the main branch. Give it a meaningful name and describe your changes in the body of the pull request. Lastly add a link to the issue this pull request closes, i.e. by writing in the description closes #123
  2. Assign the pull request to one developer to review, if you are not sure who should review the issue skip this step. Someone will assign a reviewer for you.
  3. The reviewer will look at the pull request in the following days and give you either feedback or accept the changes. Your reviewer might use emoji code during the reviewing process.
    1. If there are changes requested address them in a new commit. Notify the reviewer in a comment if the pull request is ready for review again. If the changes are accepted squash them again in the related commit and force push.
    2. If no changes are requested the reviewer will initiate a merge

Reviewing a pull request

Before doing your first review, please have a look at this guide.

As a reviewer, you are encouraged to use the following emoji code in your comments.

The review should result in:

  • approving the changes if there are only optional suggestions/minor issues 🔧, throughts 💭, or likes 👍
  • requesting changes if there are major issues ❌
  • commenting if there are open questions ❓

Review emoji code

The following emojis can be used in a review to express the intention of a comment. For example, to distinguish a required change from an optional suggestion.

  • 👍 or :+1:: This is great! It always feels good when somebody likes your work. Show them!
  • ❓ or :question:: I have a question. Please clarify.
  • ❌ or :x:: This has to change. It’s possibly an error or strongly violates existing conventions.
  • 🔧 or :wrench:: This is a well-meant suggestion or minor issue. Take it or leave it. Nothing major that blocks merging.
  • 💭 or :thought_balloon:: I’m just thinking out loud here. Something doesn’t necessarily have to change, but I want to make sure to share my thoughts.

Inspired by Microsofts emoji code.

Commit Message Guidelines

Commit messages use Conventional Commits format.

<header>
<BLANK LINE>
<body>
<BLANK LINE> (optional - mandatory with footer)
<footer> (optional)

Commit message header

Examples:

  • docs: add start event to bpmn symbol support matrix
  • perf: reduce latency in backpressure
  • feat: allow more than 9000 jobs in a single call

The commit header should match the following pattern:

%{type}(%{scope}): %{description}

The commit header should be kept short, preferably under 72 chars but we allow a max of 120 chars.

  • type should be one of:
    • build: Changes that affect the build system (e.g. Maven, Docker, etc)
    • ci: Changes to our CI configuration files and scripts (e.g. Jenkins, Bors, etc)
    • deps: A change to the external dependencies (was already used by Dependabot)
    • docs: A change to the documentation
    • feat: A new feature (both internal or user-facing)
    • fix: A bug fix (both internal or user-facing)
    • perf: A code change that improves performance
    • refactor: A code change that does not change the behavior
    • style: A change to align the code with our style guide
    • test: Adding missing tests or correcting existing tests
  • scope (optional): name of the changed component (e.g. engine, journal, README)
  • description: short description of the change in present tense

Commit message body

Should describe the motivation for the change.

Contributor License Agreement

You will be asked to sign our Contributor License Agreement when you open a Pull Request. We are not asking you to assign copyright to us, but to give us the right to distribute your code without restriction. We ask this of all contributors in order to assure our users of the origin and continuing existence of the code. You only need to sign the CLA once.

Licenses

Zeebe source files are made available under the Zeebe Community License Version 1.1 except for the parts listed below, which are made available under the Apache License, Version 2.0. See individual source files for details.

Available under the Apache License, Version 2.0:

  • Cli

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 Camunda Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior as soon as possible.