The following is a set of guidelines for contributing to the Dataspace Connector. This is an ongoing project of the Data Economy business unit of the Fraunhofer ISST hosted on GitHub. 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 that all developers should stick to.
We document changes in the CHANGELOG.md on root level which is formatted and maintained according to the rules documented on http://keepachangelog.com.
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 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:
- 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
The labels are listed at the
issues.
There are three types of labels: the type describes the content of the issue, scope helps to
specify the scope of the issue. The open for contribution label can be seen as an invitation to
contribute to the project. Independent functionalities and improvements that will not be implemented
by the core developer team are marked with it.
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, /docs, and CHANGELOG.md with necessary details. Then, create a pull request and note
that committing to the main branch is not allowed. Please use the feature linked issues to
link issues and pull requests. To mark your pull request as work in progress, please use the
provided GitHub feature. Contributions to the main branch will be squashed and merged.
We encourage all contributors to stick to the commit convention following the specification on Conventional Commits. 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.
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.
The Dataspace Connector uses the SemVer for versioning. The release versions are tagged with their respective version.