Skip to content

Latest commit

 

History

History
124 lines (85 loc) · 5.36 KB

CONTRIBUTING.md

File metadata and controls

124 lines (85 loc) · 5.36 KB
Raw

Contributing to Dataspace Connector

Thank you for your interest in contributing to the Eclipse Dataspace Connector!

Table of Contents

Project Description

See README.md for a comprehensive project description.

Code Of Conduct

See the Eclipse Code Of Conduct.

Eclipse Contributor Agreement

Before your contribution can be accepted by the project, you need to create and electronically sign a Eclipse Contributor Agreement (ECA):

  1. Log in to the Eclipse foundation website. You will need to create an account with the Eclipse Foundation if you have not already done so.
  2. Click on "Eclipse ECA", and complete the form.

Be sure to use the same email address in your Eclipse Account that you intend to use when you commit to GitHub.

How to Contribute

Discuss

If you feel there is a bug or an issue contribute to discussions in existing issues otherwise create a new issue.

Create an Issue

If you have identified a bug or just want to share an idea to further enhance the project feel free to create a new issue at our projects corresponding Github Issues page.

Before doing so please consider searching for potentially suitable existing issues.

We also use Github's default label set to classify issues and improve findability.

Adhere to coding style guide

We aim for a coherent and consistent code base, thus the coding style detailed in the styleguide should be followed.

Submit a Pull Request

In addition to the contribution guideline made available in the Eclipse project handbook we would appreciate if your pull request applies to the following points:

  • Always apply the following copyright header to specific files in your work replacing the fields enclosed by curly brackets "{}" with your own identifying information. (Don't include the curly brackets!) Enclose the text in the appropriate comment syntax for the file format.

    Copyright (c) {year} {owner}[ and others]

This program and the accompanying materials are made available under the
terms of the Apache License, Version 2.0 which is available at
https://www.apache.org/licenses/LICENSE-2.0

SPDX-License-Identifier: Apache-2.0

Contributors:
  {name} - {description}

  • The git commit messages should comply to the following format:

    <component>: <description>

    Use the imperative mood as in "Fix bug" or "Add feature" rather than "Fixed bug" or "Added feature" and mention the GitHub issue e.g. transfer process: improve logging, closes #3.

    All committers, and all commits, are bound to the Developer Certificate of Origin. As such, all parties involved in a contribution must have valid ECAs. Additionally commits can include a "Signed-off-by" entry.

  • We prefer small changes and short living branches. Please do not combine independent things in one pull request.

  • Excessive branching and merging can make git history confusing. With that in mind please

    • Squash your commits down to a few commits, or one commit, before submitting a pull request and
    • Rebase your pull request changes on top of the current master. Pull requests shouldn't include merge commits.

  • Add meaningful tests to verify your submission acts as expected.

  • Where code is not self-explanatory add documentation providing extra clarification.

  • Submit a draft pull request at early-stage and add people previously working on the same code as reviewer. Make sure automatically checks pass before marking it as "ready for review":

    • Intellectual Property Validation verifying the Eclipse CLA has been signed as well as commits have been signed-off and
    • Continuous Integration performing various test conventions.

Contact Us

If you have questions or suggestions do not hesitate to contact the project developers via the project's "dev" list.