Skip to content

Commit

Permalink
add AGPL v3.0 (or later) license (#636)
Browse files Browse the repository at this point in the history
* add license AGPL v3.0 (or later) plus exceptions
* update README.md
* downloadable source code zip
* Add DCO check in Pull Requests (enforce sign offs on commits)
  ** make it more clear that code published in the Pull Request is/needs to be under the license of this project to be merged.
---------
Signed-off-by: GitHub Actions <noreply@github.com>
Signed-off-by: Marvin <68286419+anonym-HPI@users.noreply.github.com>
Co-authored-by: Lukas Hagen <43916057+Greenscreen23@users.noreply.github.com>
Co-authored-by: Christian Zöllner <github@czoellner.de>
Co-authored-by: benn02 <82985280+benn02@users.noreply.github.com>
Co-authored-by: GitHub Actions <noreply@github.com>
Co-authored-by: Lukas Radermacher <49586507+lukasrad02@users.noreply.github.com>
  • Loading branch information
anonym-HPI committed Nov 6, 2023
1 parent e7a4005 commit e6be4d1
Show file tree
Hide file tree
Showing 18 changed files with 2,221 additions and 44 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
* text=auto
# docker-entrypoint.sh needs LF (see https://github.com/hpi-sam/digital-fuesim-manv/issues/479)
docker/docker-entrypoint.sh eol=lf
# with this export-ignore the zip file won't include itself when using git archive
frontend/src/assets/source-code/digital-fuesim-manv.zip export-ignore
8 changes: 7 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,10 @@
Please make sure to fulfil the following conditions before marking this PR ready for review:

- [ ] If this PR adds or changes features or fixes bugs, this has been added to the changelog
- [ ] If this PR adds new actions or other ways to alter the state, [test scenarios](https://github.com/hpi-sam/digital-fuesim-manv-public-test-scenarios) have been added
- [ ] If this PR adds new actions or other ways to alter the state, [test scenarios](https://github.com/hpi-sam/digital-fuesim-manv-public-test-scenarios) have been added.
- [ ] I have the right to license the code submitted with this Pull Request under the mentioned license in the file [LICENSE-README.md](LICENSE-README.md) (i.e., this is my
own code or code licensed under a license compatible to AGPL v3.0 or later, for exceptions look into [LICENSE-README.md](LICENSE-README.md)) and
hereby license the code in this Pull Request under it.
I certify that by signing off my commits (see In case of using third party code, I have given appropriate credit.
We are using DCO for that, see [here](https://github.com/dcoapp/app#how-it-works) for more information.
- [ ] If I have used third party code and I mentioned it in the code, I also updated the [inspired-by-or-copied-from-list.html](inspired-by-or-copied-from-list.html) list to include the links.
2 changes: 1 addition & 1 deletion .github/workflows/create-release-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
- name: Commit updated version and changelog
id: create-commit
run: |
git commit -a --message "Prepare release v${{ github.event.inputs.versionName }}"
git commit -a --signoff --message "Prepare release v${{ github.event.inputs.versionName }}"
echo "commit=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
- name: Push new branch
run: git push origin release/v${{ github.event.inputs.versionName }}
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ benchmark/data/*
.vscode/*
!.vscode/*.example
!.vscode/extensions.json

# mitigate accidental commit of files in source-code
frontend/src/assets/source-code/*
9 changes: 9 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,12 @@ docker-compose.yml
benchmark/data

test-scenarios/

# custom html files in about
frontend/src/assets/about

# custom files in source-code
frontend/src/assets/source-code

# custom html files
inspired-by-or-copied-from-list.html
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,15 @@ and this project does **not** adhere to [Semantic Versioning](https://semver.org

## [Unreleased]

### Added

- this software has now a license (with some exceptions), see LICENSE-README.md
- the software includes a file with third party acknoledgments, a license.html and the docker container will include a git archive of the source code downloadable in zip format
- new npm run commands for licensing (third party acknowledgements) and creating source code archive

## [0.7.1] - 2023-07-10

## Added
### Added

- Patients can be identified with an unique ID
- The ID is assigned to every patient automatically
Expand Down
22 changes: 22 additions & 0 deletions LICENSE-README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Copyright (c) 2023 See the [README.md](README.md#contributors) for authors/contributors (bottom of the document).

This software is a digital implementation of the "FüSim MANV"/"FueSim MANV" (Führungssimulation Massenanfall von Verletzen), a German paper-based simulation game for training emergency medical services leadership personnel in managing Mass Casualty Incidents.

The software is licensed under the [GNU Affero General Public License](LICENSE.md) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Exceptions apply to image files in the frontend/src/assets folder (or subfolders), which may be covered by and therefore distributed under different licenses.
The individual license for each image can be found in [frontend/src/assets/LICENSES-IMAGES.md](frontend/src/assets/LICENSES-IMAGES.md), it is also possible to link to a publically free available webpage, where the license can be easily read from (this could be the source of an image, for example). Files added to this project may only use this exception if these files serve the only purpose of being displayed and will only be parsed for the purpose of displaying them.
Another exception to the default licence exists for datasets. Datasets are files that include no new features and just contain different compositions allowed through template classes given in the source code. Datasets must always be in a publically free available human readable formats (for example csv, JSON, txt). Compressed datasets are allowed, but every user of this software must be able to decompress it again into a publically free available human readable format with the help of this software. Datasets licenses must be mentioned in a LICENSES-DATASETS.md file in the respective folder where the dataset is placed (same applies if only one dataset is in the respective folder). All license files must state explicitly which file (or files) they refer to, who the authors are and which license applies (or licenses apply).
Datasets are not allowed to create any new features or enhance the software in any way, as to create elements that can be part of an export and are importable into this software, with its source code being under the [GNU Affero General Public License](LICENSE.md) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Especially, you must not use this exception for source code files.
All exceptions can be part of another license chosen by the author of these images or datasets.

Digital FueSim MANV is free software: you can redistribute it and/or modify
it under the terms of the [GNU Affero General Public License](LICENSE.md) as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version. Exceptions are mentioned in this file [LICENSE-README.md](LICENSE-README.md).

Digital FueSim MANV is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

The GNU Affero General Public License can be found in the file named [LICENSE.md](LICENSE.md). If not, see <http://www.gnu.org/licenses/>.

0 comments on commit e6be4d1

Please sign in to comment.