Skip to content
This repository was archived by the owner on Jun 13, 2025. It is now read-only.

Commit 3ca861d

Browse files
committed
Merge branch 'release/1.0.0'
2 parents c913ad7 + a28fe99 commit 3ca861d

File tree

180 files changed

+21647
-202
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

180 files changed

+21647
-202
lines changed

.gitignore

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
11
.idea
2-
2+
.instances.ttl
3+
.manual.ttl
4+
.schema.ttl
5+
log
6+
results
7+
artifacts
8+
*.log

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "includes"]
2+
path = includes
3+
url = ssh://git@gitlab.eccenca.com:8101/devops/ontology-includes.git

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Change Log
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
5+
6+
## [1.0.0] 2018-09-30
7+
8+
### Added
9+
10+
- initial version of the IDS Information model

CONTRIBUTING.md

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
# How to contribute
2+
3+
This file documents the decisions we made for our processes and quality.
4+
5+
## Changelog
6+
7+
We document changes in the CHANGELOG.md on root level which is formatted and
8+
maintained according to the rules documented on http://keepachangelog.com.
9+
10+
## General source code rules
11+
12+
- strip whitespace at the end of lines
13+
- do not use tabs (use 4 spaces instead)
14+
- end each file with a newline (its easier to concat them then)
15+
16+
## Commits
17+
18+
### Requirements
19+
20+
Good commits serve at least these important purposes:
21+
22+
- To speed up the reviewing process
23+
- To help us write a good release note
24+
- To help the future maintainers and developers to find out why a particular change was made to the code or why a specific feature was added
25+
- generate changelog automatically
26+
27+
### Meta Data
28+
29+
Please create commits with valid meta data only. This means, you have to configure your name and mail address like this:
30+
31+
```
32+
git config --global user.name "$name"
33+
git config --global user.email "$email"
34+
```
35+
36+
### Structure
37+
38+
The format of the commit message should be:
39+
40+
```
41+
<subject>
42+
43+
<body>
44+
45+
<footer>
46+
```
47+
48+
Where
49+
- subject is a short summary of changes
50+
- body includes motivation for the change and contrasts with previous behavior
51+
- footer referencing issues, breaking changes etc.
52+
53+
Here is an example
54+
55+
```
56+
a short (50 chars or less) summary of changes
57+
58+
Body of the commit message, a more detailed explanatory text, if necessary.
59+
Wrap it to about 72 characters or so. In some contexts, the first
60+
line is treated as the subject of an email and the rest of the text
61+
as the body. The blank line separating the summary from the body is
62+
critical (unless you omit the body entirely); tools like rebase
63+
can get confused if you run the two together.
64+
65+
Further paragraphs come after blank lines.
66+
67+
- Bullet points are okay, too
68+
- a hyphen is used for the bullet, preceded by a single space, with blank lines in between
69+
```
70+
71+
### Style
72+
73+
Basic recommendations are:
74+
75+
- Write the subject line of what you have done in the imperative mode, that is as if you were commanding someone.
76+
- Write "fix", "add", "change" instead of "fixed", "added", "changed".
77+
- Don't end the subject line with a period - it's a title and titles don't end with a period.
78+
- Don't add parentheses or other stylish elements to the subject line.
79+
- Always leave the second line blank (the line between the subject line and the body)
80+
- Line break the commit message at about 72 chars (to make the commit message readable without having to scroll horizontally
81+
- Add a newline at the end of every document/file which is part of the repository
82+
83+
A properly formed git commit subject line should always be able to complete the following sentence:
84+
85+
- If applied, this commit will your subject line here
86+
87+
For example:
88+
89+
- If applied, this commit will refactor subsystem X for readability
90+
- If applied, this commit will update getting started documentation
91+
- If applied, this commit will release version 1.0.0
92+
93+
Notice how this doesn't work for the other non-imperative forms:
94+
95+
- If applied, this commit will fixed bug with Y
96+
- If applied, this commit will changing behavior of X
97+
- If applied, this commit will more fixes for broken stuff
98+
- If applied, this commit will sweet new class
99+
100+
Use of the imperative is important only in the subject line. You can relax this restriction when you're writing the body.
101+
102+
If it seems difficult to summarize what your commit does, it may be because it includes several logical changes or bug fixes, and are better split up into several commits using `git add -p`.
103+
104+
### Branching Model
105+
106+
The branching model defines the basic workflow for different activities in the repository. These activities include:
107+
108+
- add a new feature
109+
- fix a bug and provide this fix on different versions
110+
- prepare and release a version
111+
112+
Our used branching model is an enhanced version of the model by [Vincent Driessen](http://nvie.com/posts/a-successful-git-branching-model/).
113+
The important variation is the back-merge from the the tagged master onto the develop branch.
114+
This enables the power of the `git describe --always --dirty` command, which outputs an ID for the whole process.
115+
116+
#### Requirements
117+
118+
- we want to use git describe in order to get valid version identifiers on every commit checkout
119+
- more accurate, we want to use `git describe --always --dirty`
120+
- we want to manage all of our versions with tags, including full versions, release candidates, ...
121+
122+
#### Feature Branches
123+
124+
- Every new feature will be developed in its own feature branch off from develop
125+
- Each feature will follow this naming: feature/featureName (where feature name is some descriptive feature name, 2 words most, camel case)
126+
- Regularly push your work to the same named feature branch on the server
127+
- If you need newest changes from develop merge it into your feature branch using git merge --no-ff
128+
- Avoid cross-merging of other feature branches
129+
- CONVENTION: merge your feature branch into develop by opening a pull request
130+
- Always merge your feature branch into develop using git merge --no-ff
131+
- BEWARE: Do not execute git config --global --add merge.ff false! Once you have this parameter as a default, it will provoke merge commits even when updating a branch (pull).
132+
133+
#### Bugfix Branches
134+
135+
- Same procedure as with feature branches. The only difference is the naming policy: `bugfix/bugfixName` (where bugfix name is some descriptive name for the fixed problem, 2 words most, camel case)
136+
137+
#### Release Branches
138+
139+
- Release branches follow this naming: release/vX.Y.Z
140+
- Release branches are created from the develop branch
141+
- git checkout develop; git checkout -b release/vX.Y.Z
142+
- The first fix commit in a release branch CAN be tagged as a release candidate
143+
- git commit -m "fix important bug for release"; git tag vX.Y.Z-rc1 -s
144+
- use GPG signed tags
145+
- the intention of an RC is to state the version as 'almost stable' in the sense that it can be tested as a release artefact there are no further modifications planned, other than small bugfixes required if found during testing. If fixes occur after declaring an RC (e.g. rc1), then a new RC should be published (rc2)
146+
- Once a release branch is stabilized, it will be **FIRST** merged to master and **THEN** tagged with the version tag
147+
- git checkout master; git pull; git merge --no-ff release/vX.Y.Z; git tag vX.Y.Z -s
148+
- After the release tag is pushed, the TAG (not the master branch) is merged into develop
149+
- git checkout develop; git merge vX.Y.Z
150+
- Afterwards, set the next pre-version (e.g. you just release version 3.2.0, you tag the develop to 3.2.1-pre)
151+
- git tag -s vX.Y.Z+1-pre
152+
- Note: After creating tags, you need to upload them, as well as the changed branches
153+
- git push --tags; git push origin master; git push origin develop
154+

LICENSE

Lines changed: 10 additions & 198 deletions
Original file line numberDiff line numberDiff line change
@@ -1,202 +1,14 @@
1+
Copyright 2018 International Data Spaces Association
12

2-
Apache License
3-
Version 2.0, January 2004
4-
http://www.apache.org/licenses/
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
56

6-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
http://www.apache.org/licenses/LICENSE-2.0
78

8-
1. Definitions.
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.
914

10-
"License" shall mean the terms and conditions for use, reproduction,
11-
and distribution as defined by Sections 1 through 9 of this document.
12-
13-
"Licensor" shall mean the copyright owner or entity authorized by
14-
the copyright owner that is granting the License.
15-
16-
"Legal Entity" shall mean the union of the acting entity and all
17-
other entities that control, are controlled by, or are under common
18-
control with that entity. For the purposes of this definition,
19-
"control" means (i) the power, direct or indirect, to cause the
20-
direction or management of such entity, whether by contract or
21-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22-
outstanding shares, or (iii) beneficial ownership of such entity.
23-
24-
"You" (or "Your") shall mean an individual or Legal Entity
25-
exercising permissions granted by this License.
26-
27-
"Source" form shall mean the preferred form for making modifications,
28-
including but not limited to software source code, documentation
29-
source, and configuration files.
30-
31-
"Object" form shall mean any form resulting from mechanical
32-
transformation or translation of a Source form, including but
33-
not limited to compiled object code, generated documentation,
34-
and conversions to other media types.
35-
36-
"Work" shall mean the work of authorship, whether in Source or
37-
Object form, made available under the License, as indicated by a
38-
copyright notice that is included in or attached to the work
39-
(an example is provided in the Appendix below).
40-
41-
"Derivative Works" shall mean any work, whether in Source or Object
42-
form, that is based on (or derived from) the Work and for which the
43-
editorial revisions, annotations, elaborations, or other modifications
44-
represent, as a whole, an original work of authorship. For the purposes
45-
of this License, Derivative Works shall not include works that remain
46-
separable from, or merely link (or bind by name) to the interfaces of,
47-
the Work and Derivative Works thereof.
48-
49-
"Contribution" shall mean any work of authorship, including
50-
the original version of the Work and any modifications or additions
51-
to that Work or Derivative Works thereof, that is intentionally
52-
submitted to Licensor for inclusion in the Work by the copyright owner
53-
or by an individual or Legal Entity authorized to submit on behalf of
54-
the copyright owner. For the purposes of this definition, "submitted"
55-
means any form of electronic, verbal, or written communication sent
56-
to the Licensor or its representatives, including but not limited to
57-
communication on electronic mailing lists, source code control systems,
58-
and issue tracking systems that are managed by, or on behalf of, the
59-
Licensor for the purpose of discussing and improving the Work, but
60-
excluding communication that is conspicuously marked or otherwise
61-
designated in writing by the copyright owner as "Not a Contribution."
62-
63-
"Contributor" shall mean Licensor and any individual or Legal Entity
64-
on behalf of whom a Contribution has been received by Licensor and
65-
subsequently incorporated within the Work.
66-
67-
2. Grant of Copyright License. Subject to the terms and conditions of
68-
this License, each Contributor hereby grants to You a perpetual,
69-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70-
copyright license to reproduce, prepare Derivative Works of,
71-
publicly display, publicly perform, sublicense, and distribute the
72-
Work and such Derivative Works in Source or Object form.
73-
74-
3. Grant of Patent License. Subject to the terms and conditions of
75-
this License, each Contributor hereby grants to You a perpetual,
76-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77-
(except as stated in this section) patent license to make, have made,
78-
use, offer to sell, sell, import, and otherwise transfer the Work,
79-
where such license applies only to those patent claims licensable
80-
by such Contributor that are necessarily infringed by their
81-
Contribution(s) alone or by combination of their Contribution(s)
82-
with the Work to which such Contribution(s) was submitted. If You
83-
institute patent litigation against any entity (including a
84-
cross-claim or counterclaim in a lawsuit) alleging that the Work
85-
or a Contribution incorporated within the Work constitutes direct
86-
or contributory patent infringement, then any patent licenses
87-
granted to You under this License for that Work shall terminate
88-
as of the date such litigation is filed.
89-
90-
4. Redistribution. You may reproduce and distribute copies of the
91-
Work or Derivative Works thereof in any medium, with or without
92-
modifications, and in Source or Object form, provided that You
93-
meet the following conditions:
94-
95-
(a) You must give any other recipients of the Work or
96-
Derivative Works a copy of this License; and
97-
98-
(b) You must cause any modified files to carry prominent notices
99-
stating that You changed the files; and
100-
101-
(c) You must retain, in the Source form of any Derivative Works
102-
that You distribute, all copyright, patent, trademark, and
103-
attribution notices from the Source form of the Work,
104-
excluding those notices that do not pertain to any part of
105-
the Derivative Works; and
106-
107-
(d) If the Work includes a "NOTICE" text file as part of its
108-
distribution, then any Derivative Works that You distribute must
109-
include a readable copy of the attribution notices contained
110-
within such NOTICE file, excluding those notices that do not
111-
pertain to any part of the Derivative Works, in at least one
112-
of the following places: within a NOTICE text file distributed
113-
as part of the Derivative Works; within the Source form or
114-
documentation, if provided along with the Derivative Works; or,
115-
within a display generated by the Derivative Works, if and
116-
wherever such third-party notices normally appear. The contents
117-
of the NOTICE file are for informational purposes only and
118-
do not modify the License. You may add Your own attribution
119-
notices within Derivative Works that You distribute, alongside
120-
or as an addendum to the NOTICE text from the Work, provided
121-
that such additional attribution notices cannot be construed
122-
as modifying the License.
123-
124-
You may add Your own copyright statement to Your modifications and
125-
may provide additional or different license terms and conditions
126-
for use, reproduction, or distribution of Your modifications, or
127-
for any such Derivative Works as a whole, provided Your use,
128-
reproduction, and distribution of the Work otherwise complies with
129-
the conditions stated in this License.
130-
131-
5. Submission of Contributions. Unless You explicitly state otherwise,
132-
any Contribution intentionally submitted for inclusion in the Work
133-
by You to the Licensor shall be under the terms and conditions of
134-
this License, without any additional terms or conditions.
135-
Notwithstanding the above, nothing herein shall supersede or modify
136-
the terms of any separate license agreement you may have executed
137-
with Licensor regarding such Contributions.
138-
139-
6. Trademarks. This License does not grant permission to use the trade
140-
names, trademarks, service marks, or product names of the Licensor,
141-
except as required for reasonable and customary use in describing the
142-
origin of the Work and reproducing the content of the NOTICE file.
143-
144-
7. Disclaimer of Warranty. Unless required by applicable law or
145-
agreed to in writing, Licensor provides the Work (and each
146-
Contributor provides its Contributions) on an "AS IS" BASIS,
147-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148-
implied, including, without limitation, any warranties or conditions
149-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150-
PARTICULAR PURPOSE. You are solely responsible for determining the
151-
appropriateness of using or redistributing the Work and assume any
152-
risks associated with Your exercise of permissions under this License.
153-
154-
8. Limitation of Liability. In no event and under no legal theory,
155-
whether in tort (including negligence), contract, or otherwise,
156-
unless required by applicable law (such as deliberate and grossly
157-
negligent acts) or agreed to in writing, shall any Contributor be
158-
liable to You for damages, including any direct, indirect, special,
159-
incidental, or consequential damages of any character arising as a
160-
result of this License or out of the use or inability to use the
161-
Work (including but not limited to damages for loss of goodwill,
162-
work stoppage, computer failure or malfunction, or any and all
163-
other commercial damages or losses), even if such Contributor
164-
has been advised of the possibility of such damages.
165-
166-
9. Accepting Warranty or Additional Liability. While redistributing
167-
the Work or Derivative Works thereof, You may choose to offer,
168-
and charge a fee for, acceptance of support, warranty, indemnity,
169-
or other liability obligations and/or rights consistent with this
170-
License. However, in accepting such obligations, You may act only
171-
on Your own behalf and on Your sole responsibility, not on behalf
172-
of any other Contributor, and only if You agree to indemnify,
173-
defend, and hold each Contributor harmless for any liability
174-
incurred by, or claims asserted against, such Contributor by reason
175-
of your accepting any such warranty or additional liability.
176-
177-
END OF TERMS AND CONDITIONS
178-
179-
APPENDIX: How to apply the Apache License to your work.
180-
181-
To apply the Apache License to your work, attach the following
182-
boilerplate notice, with the fields enclosed by brackets "[]"
183-
replaced with your own identifying information. (Don't include
184-
the brackets!) The text should be enclosed in the appropriate
185-
comment syntax for the file format. We also recommend that a
186-
file or class name and description of purpose be included on the
187-
same "printed page" as the copyright notice for easier
188-
identification within third-party archives.
189-
190-
Copyright [yyyy] [name of copyright owner]
191-
192-
Licensed under the Apache License, Version 2.0 (the "License");
193-
you may not use this file except in compliance with the License.
194-
You may obtain a copy of the License at
195-
196-
http://www.apache.org/licenses/LICENSE-2.0
197-
198-
Unless required by applicable law or agreed to in writing, software
199-
distributed under the License is distributed on an "AS IS" BASIS,
200-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201-
See the License for the specific language governing permissions and
202-
limitations under the License.

0 commit comments

Comments
 (0)