Link

Open Integration Hub



Contributor Guide

This document aggregates all information on how to contribute to the project.

For technical specifications and guidelines like naming conventions, styleguides, definitions of done or operations, please refer to the corresponding workgroup and repository.

Table of Content

Welcome to the Open Integration Hub Community!

Before you get started

Sign the Contributor License Agreement

It is important for you as a Contributor as well as the project and all it’s users, that we are clear on who owns the code. All contributions have to be made according to the License Agreement.

Before you can contribute code, you will need to sign the Contributor License Agreement.

The Cloud Ecosystem defines the legal status of the contributed code in two different types of Contributor License Agreements (CLAs), individual contributors and companies.

The Open Integration Hub Project can only accept original source code from CLA signatories.

It is important to read and understand this legal agreement.

Code of Conduct

Please read and observe our Code of Conduct.

How to contribute

GitHub Workflow

We follow the general GitHub workflow, if you are not familiar with working with GitHub, please refer to the GitHub Workflow Guide.

Pull Requests

  1. Commit new file(s) e.g. data models
  2. Select “Create a new branch for this commit and start a pull request.”
  3. Name the branch with a descriptive name
  4. Click on “propose new file”
  5. Assign the workgroup manager to the pull request
  6. Assign a descriptive label to the pull request
  7. Click on “create pull request”

If you don’t know whom to assign, choose: @philecs

Issues

For any issue (suggestion, bug, fix, etc.) there are fundamentally two ways an individual can contribute:

  • By helping to triage the issue: This can be done either by providing supporting details (a test case that demonstrates a bug), or providing suggestions on how to address the issue.
  • By helping to resolve the issue: Typically this is done either in the form of demonstrating that the issue reported is not a problem after all, or more often, by opening a Pull Request that changes some bit of something in Open Integration Hub in a concrete and reviewable manner.

Where to contribute

Understanding the structure

The project is build by many enthusiasts from various backgrounds, countries and skillsets. To bring all of us together and work effectively, organization and structure is needed. To know where to get involved best, please take the time to understand how we work.

Committees

Committees are groups of elected Committers, responsible for the operative business and defining, prioritizing and executing all tasks necessary to achieve the project’s goals and to ensure a steady development. Committees set up workgroups for specific topics and function as escalation layer for problems within these workgroup. For more information, please see the Open Integration Hub Charter.

We currently have two Committees, which are a good entry point for you, if are looking for something to work on.

Technology Committee responsible for the development of the framework, it’s releases and management of the process via the product backlog.

Business Committee responsible for all community-facing topics, as well as topics relevant for commercial use of the framework.

Workgroups

  • Each workgroup has at least one status call every two weeks
  • Every Committer of that workgroup must attend the status call
  • Decisions within a workgroup are made by all committers (unanimously)
  • If it is not possible to decide on a certain issue/topic it must be escalated to the corresponding committee

Community

Get involved

Meetups

Contact: info@cloudecosystem.org

Roles within the Community

There are several roles you can take on within the community, starting by being a Contributor. If you want to learn more, check out the Community Guide