Skip to content

Commit

Permalink
Merge branch 'release/1.0.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
@seebi
seebi committed Sep 30, 2018
2 parents c913ad7 + a28fe99 commit 3ca861d
Show file tree
Hide file tree
Showing 180 changed files with 21,647 additions and 202 deletions.
8 changes: 7 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
.idea

.instances.ttl
.manual.ttl
.schema.ttl
log
results
artifacts
*.log
3 changes: 3 additions & 0 deletions .gitmodules
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "includes"]
path = includes
url = ssh://[email protected]:8101/devops/ontology-includes.git
10 changes: 10 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Change Log
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).

## [1.0.0] 2018-09-30

### Added

- initial version of the IDS Information model
154 changes: 154 additions & 0 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
# How to contribute

This file documents the decisions we made for our processes and quality.

## Changelog

We document changes in the CHANGELOG.md on root level which is formatted and
maintained according to the rules documented on http://keepachangelog.com.

## General source code rules

- strip whitespace at the end of lines
- do not use tabs (use 4 spaces instead)
- end each file with a newline (its easier to concat them then)

## Commits

### Requirements

Good commits serve at least these important purposes:

- To speed up the reviewing process
- To help us write a good release note
- 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
- generate changelog automatically

### Meta Data

Please create commits with valid meta data only. This means, you have to configure your name and mail address like this:

```
git config --global user.name "$name"
git config --global user.email "$email"
```

### Structure

The format of the commit message should be:

```
<subject>
<body>
<footer>
```

Where
- subject is a short summary of changes
- body includes motivation for the change and contrasts with previous behavior
- footer referencing issues, breaking changes etc.

Here is an example

```
a short (50 chars or less) summary of changes
Body of the commit message, a more detailed explanatory text, if necessary.
Wrap it to about 72 characters or so. In some contexts, the first
line is treated as the subject of an email and the rest of the text
as the body. The blank line separating the summary from the body is
critical (unless you omit the body entirely); tools like rebase
can get confused if you run the two together.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- a hyphen is used for the bullet, preceded by a single space, with blank lines in between
```

### Style

Basic recommendations are:

- Write the subject line of what you have done in the imperative mode, that is as if you were commanding someone.
- Write "fix", "add", "change" instead of "fixed", "added", "changed".
- Don't end the subject line with a period - it's a title and titles don't end with a period.
- Don't add parentheses or other stylish elements to the subject line.
- Always leave the second line blank (the line between the subject line and the body)
- Line break the commit message at about 72 chars (to make the commit message readable without having to scroll horizontally
- Add a newline at the end of every document/file which is part of the repository

A properly formed git commit subject line should always be able to complete the following sentence:

- If applied, this commit will your subject line here

For example:

- If applied, this commit will refactor subsystem X for readability
- If applied, this commit will update getting started documentation
- If applied, this commit will release version 1.0.0

Notice how this doesn't work for the other non-imperative forms:

- If applied, this commit will fixed bug with Y
- If applied, this commit will changing behavior of X
- If applied, this commit will more fixes for broken stuff
- If applied, this commit will sweet new class

Use of the imperative is important only in the subject line. You can relax this restriction when you're writing the body.

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`.

### Branching Model

The branching model defines the basic workflow for different activities in the repository. These activities include:

- add a new feature
- fix a bug and provide this fix on different versions
- prepare and release a version

Our used branching model is an enhanced version of the model by [Vincent Driessen](http://nvie.com/posts/a-successful-git-branching-model/).
The important variation is the back-merge from the the tagged master onto the develop branch.
This enables the power of the `git describe --always --dirty` command, which outputs an ID for the whole process.

#### Requirements

- we want to use git describe in order to get valid version identifiers on every commit checkout
- more accurate, we want to use `git describe --always --dirty`
- we want to manage all of our versions with tags, including full versions, release candidates, ...

#### Feature Branches

- Every new feature will be developed in its own feature branch off from develop
- Each feature will follow this naming: feature/featureName (where feature name is some descriptive feature name, 2 words most, camel case)
- Regularly push your work to the same named feature branch on the server
- If you need newest changes from develop merge it into your feature branch using git merge --no-ff
- Avoid cross-merging of other feature branches
- CONVENTION: merge your feature branch into develop by opening a pull request
- Always merge your feature branch into develop using git merge --no-ff
- 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).

#### Bugfix Branches

- 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)

#### Release Branches

- Release branches follow this naming: release/vX.Y.Z
- Release branches are created from the develop branch
- git checkout develop; git checkout -b release/vX.Y.Z
- The first fix commit in a release branch CAN be tagged as a release candidate
- git commit -m "fix important bug for release"; git tag vX.Y.Z-rc1 -s
- use GPG signed tags
- 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)
- Once a release branch is stabilized, it will be **FIRST** merged to master and **THEN** tagged with the version tag
- git checkout master; git pull; git merge --no-ff release/vX.Y.Z; git tag vX.Y.Z -s
- After the release tag is pushed, the TAG (not the master branch) is merged into develop
- git checkout develop; git merge vX.Y.Z
- Afterwards, set the next pre-version (e.g. you just release version 3.2.0, you tag the develop to 3.2.1-pre)
- git tag -s vX.Y.Z+1-pre
- Note: After creating tags, you need to upload them, as well as the changed branches
- git push --tags; git push origin master; git push origin develop

208 changes: 10 additions & 198 deletions LICENSE
View file
Original file line number Diff line number Diff line change
@@ -1,202 +1,14 @@
Copyright 2018 International Data Spaces Association

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

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

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

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Loading

0 comments on commit 3ca861d

Please sign in to comment.