forked from FraunhoferISST/DataspaceConnector
-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #112 from FraunhoferISST/develop
release v4.0.0
- Loading branch information
Showing
112 changed files
with
8,245 additions
and
4,895 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# This workflow will build a Java project with Maven | ||
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven | ||
|
||
name: Java CI with Maven | ||
|
||
on: | ||
push: | ||
branches: [ develop ] | ||
pull_request: | ||
branches: [ develop ] | ||
|
||
jobs: | ||
build: | ||
runs-on: ${{ matrix.os }} | ||
strategy: | ||
fail-fast: false | ||
matrix: | ||
os: [ubuntu-latest, windows-latest, macos-latest] | ||
java: [11, 12, 13, 14, 15] | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Set up JDK ${{ matrix.java }} | ||
uses: actions/setup-java@v1 | ||
with: | ||
java-version: ${{ matrix.java }} | ||
- name: Cache maven packages | ||
uses: actions/cache@v2 | ||
with: | ||
path: ~/.m2 | ||
key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} | ||
restore-keys: ${{ runner.os }}-m2 | ||
- name: Build with Maven | ||
run: mvn -B -U verify --file pom.xml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,8 @@ target/ | |
!**/src/main/** | ||
!**/src/test/** | ||
|
||
/log/ | ||
|
||
### STS ### | ||
.apt_generated | ||
.classpath | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
## Code of Conduct | ||
|
||
### Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
nationality, personal appearance, race, religion, or sexual identity and | ||
orientation. | ||
|
||
### Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
### Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
### Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
### Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
### Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), | ||
version 1.4, available at http://contributor-covenant.org/version/1/4. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,123 +1,86 @@ | ||
# Contributing to the Dataspace Connector | ||
|
||
The following is a set of guidelines for contributing to The Dataspace Connector. This is an ongoing project of the [Data Economy](https://www.isst.fraunhofer.de/en/business-units/data-economy.html) business unit of the [Fraunhofer ISST](https://www.isst.fraunhofer.de/en.html) hosted on [GitHub](https://github.com/FraunhoferISST/Dataspace-Connector). You are very welcome to contribute to this project when you find a bug, want to suggest an improvement, or have an idea for a useful feature. For this, always create an issue and a corresponding pull request, and follow our style guides as described below. | ||
The following is a set of guidelines for contributing to The Dataspace Connector. This is an ongoing | ||
project of the [Data Economy](https://www.isst.fraunhofer.de/en/business-units/data-economy.html) | ||
business unit of the [Fraunhofer ISST](https://www.isst.fraunhofer.de/en.html) hosted on | ||
[GitHub](https://github.com/FraunhoferISST/Dataspace-Connector). You are very welcome to contribute | ||
to this project when you find a bug, want to suggest an improvement, or have an idea for a useful | ||
feature. For this, always create an issue and a corresponding branch, and follow our style | ||
guides as described below. | ||
|
||
Please note that we have a [code of conduct](#code-of-conduct) that all developers should stick to. | ||
Please note that we have a [code of conduct](CODE_OF_CONDUCT.md) that all developers should stick to. | ||
|
||
## Changelog | ||
|
||
We document changes in the [CHANGELOG.md](CHANGELOG.md) on root level which is formatted and maintained according to the rules documented on http://keepachangelog.com. | ||
We document changes in the [CHANGELOG.md](CHANGELOG.md) on root level which is formatted and | ||
maintained according to the rules documented on http://keepachangelog.com. | ||
|
||
## Issues | ||
|
||
You always have to create an issue if you want to integrate a bugfix, improvement, or feature. Briefly and clearly describe the purpose of your contribution in the corresponding issue. The pre-defined [labels](#labels) improve the understanding of your intentions and help to follow the scope of your changes. | ||
You always have to create an issue if you want to integrate a bugfix, improvement, or feature. | ||
Briefly and clearly describe the purpose of your contribution in the corresponding issue. | ||
The pre-defined [labels](#labels) improve the understanding of your intentions and help to follow | ||
the scope of your changes. | ||
|
||
**Bug Report**: As mentioned above, bug reports should be submitted as an issue. To give others the chance to reproduce the error in order to find a solution as quickly as possible, the report should at least include the following information: | ||
**Bug Report**: As mentioned above, bug reports should be submitted as an issue. To give others | ||
the chance to reproduce the error in order to find a solution as quickly as possible, the report | ||
should at least include the following information: | ||
* Description: What did you expect and what happened instead? | ||
* Steps to reproduce (system specs included) | ||
* Relevant logs and/or media (optional): e.g. an image | ||
|
||
## Labels | ||
|
||
The labels are also listed at the menu item `Issues`. There are two types of labels: one describes the content of the issue and should be used by the developer that creates the issue. The other one, starting with `status`, will be added from the developer that takes on the issue. New issues should be initially marked with `status:open`. | ||
The [labels](https://github.com/FraunhoferISST/DataspaceConnector/labels) are listed at the | ||
[issues](https://github.com/FraunhoferISST/DataspaceConnector/issues). | ||
There are three types of labels: one describes the content of the issue and should be used by the | ||
developer that creates the issue. The other one, starting with `status`, will be added from the | ||
developer that takes on the issue. New issues should be initially marked with `status:open`. | ||
Furthermore, the issues `core-functionality` and `ids-functionality` help to specify the scope of | ||
the issue. They map the structure of the roadmap. | ||
* Basic labels: `bug`, `enhancement`, `suggestion`, `documentation` `outdated`, `question`, `discussion` | ||
* `status:closed`: issue is closed (after successful approval by issuer and QA) | ||
* `status:duplicate`: issue is a duplicate of another linked issue and therefore discontinued | ||
* `status:in-progress`: issue has been assigned and is currently being worked on | ||
* `status:on-hold`: issue may be implemented at a later date | ||
* `status:open`: issue has been submitted or re-opened recently | ||
* `status:out-of-scope`: issue is considered out of the project's scope and therefore not further considered | ||
* `status:resolved`: issue has been implemented and tested by a developer | ||
* `status:wont-fix`: issue is in scope but considered impossible or too expensive to deal with | ||
|
||
## Branches | ||
|
||
After creating an issue yourself or if you want to address an existing issue, you have to create a branch with a unique number and name that assigns it to an issue. Therefore, follow the guidelines at https://deepsource.io/blog/git-branch-naming-conventions/. After your changes, update the README.md and CHANGELOG.md with details of changes. Then, create a pull request and note that **committing to the master is not allowed**. Please use the feature `Linked issues` to link issues and pull requests. | ||
This repository has a `dev` branch in addition to the `master` branch. The idea is to always | ||
merge other branches into the `dev` branch (as SNAPSHOT version) and to push the changes from | ||
there into the `master` only for releases. This way, the `dev` branch is always up to date, | ||
with the risk of small issues, while the `master` only contains official releases. | ||
|
||
After creating an issue yourself or if you want to address an existing issue, you have to create a | ||
branch with a unique number and name that assigns it to an issue. Therefore, follow the guidelines | ||
at https://deepsource.io/blog/git-branch-naming-conventions/. After your changes, update the | ||
`README.md`, Wiki, and `CHANGELOG.md` with necessary details. Then, create a pull request and note | ||
that **committing to the master is not allowed**. Please use the feature `linked issues` to link | ||
issues and pull requests. | ||
|
||
## Commits | ||
|
||
We encourage all contributors to stick to the commit convention following the specification on [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). In general, use the imperative in the present tense. A quick overview of the schema: | ||
We encourage all contributors to stick to the commit convention following the specification on | ||
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). In general, use the | ||
imperative in the present tense. A quick overview of the schema: | ||
``` | ||
<type>[optional scope]: <description> | ||
[optional body] | ||
[optional footer(s)] | ||
``` | ||
|
||
Types: `fix`, `feat`, `chore`, `test`, `refactor`, `docs`, `release`. Append `!` for breaking changes to a type. | ||
Types: `fix`, `feat`, `chore`, `test`, `refactor`, `docs`, `release`. Append `!` for breaking | ||
changes to a type. | ||
|
||
An example of a very good commit might look like this: `feat![login]: add awesome breaking feature` | ||
|
||
**Pay attention to never push your IDS keystore or certificate to the repository - not in a single commit! Therefore, the `resources/conf` directory is added to the `.gitignore`.** | ||
**Pay attention to never push your IDS keystore or certificate to the repository - not in a single | ||
commit! Therefore, the `resources/conf` directory is added to the `.gitignore`.** | ||
|
||
## Versioning | ||
The Dataspace Connector uses the [SemVer](https://semver.org/) for versioning. The release versions are tagged with their respective version. | ||
|
||
## Code of Conduct | ||
|
||
### Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
nationality, personal appearance, race, religion, or sexual identity and | ||
orientation. | ||
|
||
### Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
### Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
### Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
### Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
### Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at http://contributor-covenant.org/version/1/4. | ||
The Dataspace Connector uses the [SemVer](https://semver.org/) for versioning. The release versions | ||
are tagged with their respective version. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.