Skip to content

Latest commit

 

History

History
111 lines (80 loc) · 3.65 KB

How to contribute.md

File metadata and controls

111 lines (80 loc) · 3.65 KB
Raw

Contribution details

To contribute to the ssi credential issuer as part of the open source community, please read the details defined below. Besides a generic "how to", some commit and pull request (PR) guidelines are defined to ensure readability and make newly created PRs easier to review. Additionally, changelogs can get validated as well as written with more ease. Moreover, similar patterns are in use across the contributor community.

Content:

How To Contribute

1 Create a fork

Open github - "eclipse-tractusx" project and select the respective repository to which you want to contribute. Create a fork of the respective repo.

2 Fork setup

Setup your fork by entering a name and make sure that you unselect the "main branch only" selection, in case the original repository has a dev and a main branch.

Click "Create fork"

3 Commit

With the newly created fork, you can now start to contribute. Create a new branch in your own fork and start to implement the planned changes or new features. When the implementation is ready, create a PR against the original repository.

The PR will get reviewed by the repository owners/official committers. As part of the pr review, sonarcloud will run automatically, and unit tests (if configured) will get executed. The PR owner is responsible to check the results and fix possible findings.

Commit and PR guidelines

Commits

The suggestion is to use Conventional Commits.

Here are some examples

Feature branch:

%%{init: { 'logLevel': 'debug', 'theme': 'base' } }%%
gitGraph
    commit id: "release(1.0.0): merge in main"
    branch dev order: 1
    checkout dev
    branch feature/feature1 order: 2
    commit id:"feat(function): add feature1"
    commit id:"feat(function): enable feature1"
Loading

Bugfix branch:

%%{init: { 'logLevel': 'debug', 'theme': 'base' } }%%
gitGraph
    commit id: "release(1.0.0): merge in main"
    branch dev order: 1
    checkout dev
    branch bug/bug1  order: 3
    commit id: "fix(function): change bug1"
    checkout bug/bug1
    commit id:"fix(function): refactor bug1"
Loading

Release branch:

%%{init: { 'logLevel': 'debug', 'theme': 'base' } }%%
gitGraph
    commit id: "release: v1.0.0"
    branch dev order: 1
    checkout dev
    branch release/1.1.0 order: 2
    commit id: "release(1.1.0): aggregate migrations (backend)"
    commit id: "release(1.1.0): update version, changelog..." tag: "1.1.0"
Loading

Hotfix branch:

%%{init: { 'logLevel': 'debug', 'theme': 'base' } }%%
gitGraph
    commit id: "release: v1.0.0"
    branch dev order: 1
    checkout dev
    branch release/1.1.0 order: 2
    commit id: "release(1.1.0): aggregate migrations (backend)"
    commit id: "release(1.1.0): update version, changelog..." tag: "1.1.0"
    checkout release/1.1.0
    branch hotfix/1.1.1 order: 3
    commit id: "hotfix(1.1.1): update version, changelog..." tag: "1.1.1"
Loading

PR title

The suggested naming convention is '{type}{(function)}: {short summary}'

PR description

Add details to the change, fix or feature in the PR description. What was changed, why was it changed (e.g. which issue was fixed or which requirement was implemented), and how was it changed.

NOTICE

This work is licensed under the Apache-2.0.