Merge pull request #64 from rl-institut/feature-33-versions

Add copyright notices with REUSE Software

.github/pull_request_template.md

@@ -20,7 +20,7 @@ Describe the findings of the discussion in the issue or meeting.
 
 ### Automation
 
-Closes #
+Part of # / Closes #
 
 ### PR-Assignee
 

.github/workflows/automated-testing.yml

@@ -1,9 +1,7 @@
-# SPDX-FileCopyrightText: 2023 Jonas Huber <@jh-RLI>
-# SPDX-FileCopyrightText: © Reiner Lemoine Institut
-#
-# SPDX-License-Identifier: MIT
+# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: Jonas Huber (jh-RLI) © Reiner Lemoine Institut
+# SPDX-License-Identifier: CC0-1.0
 
-# tox environments that run on both pull requests and merge to main
 name: automated-testing
 
 on:
@@ -18,7 +16,7 @@ jobs:
       # fail-fast: false
       matrix:
         platform: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.7, 3.9]
+        python-version: [3.8, 3.9]
         # you can separate the tox-envs in different .yml files
         # see version 0.10.1
         # https://github.com/joaomcteixeira/python-project-skeleton/releases/tag/v0.10.1

.github/workflows/gh-pages.yml

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+# SPDX-License-Identifier: CC0-1.0
+
 name: gh-pages (develop branch)
 on:
   push:

.gitignore

@@ -1,4 +1,6 @@
-# source: https://github.com/github/gitignore/blob/main/Python.gitignore
+# SPDX-FileCopyrightText: : Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+# SPDX-License-Identifier: CC0-1.0
+# Source: https://github.com/github/gitignore/blob/main/Python.gitignore
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

.pre-commit-config.yaml

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: : Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+# SPDX-License-Identifier: CC0-1.0
+
 # exclude webdevelopement build artefacts
 exclude: ^.*(.min.js|.min.css)$
 
@@ -60,6 +63,12 @@ repos:
     - id: prettier
       files: \.(css|less|md|json|sql)$
 
+  # REUSE Software - Make licensing easy for humans and machines alike
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v1.0.0
+    hooks:
+    - id: reuse
+
   # Linter for JavaScript
   # - repo: https://github.com/pre-commit/mirrors-eslint
   #   rev: v8.38.0

.reuse/dep5

@@ -0,0 +1,22 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: Super-Repo
+Upstream-Contact: Ludwig Hülk <https://github.com/Ludee>
+Source: https://github.com/rl-institut/super-repo
+
+Files: .github/*
+Copyright: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+           Jonas Huber (jh-RLI) © Reiner Lemoine Institut
+License: CC0-1.0
+
+Files: docs/*
+Copyright: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+           Jonas Huber (jh-RLI) © Reiner Lemoine Institut
+License: CC-BY-4.0
+
+Files: README.rst
+Copyright: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+License: MIT
+
+Files: pyproject.toml
+Copyright: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+License: CC0-1.0

CHANGELOG.md

@@ -1,3 +1,8 @@
+<!--
+SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+SPDX-License-Identifier: CC0-1.0
+-->
+
 # Changelog
 
 All notable changes to this project will be documented in this file. <br>
@@ -16,6 +21,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add a community chat on Element [(#59)](https://github.com/rl-institut/super-repo/pull/59)
 - Add documentation on the regular community meetings [(#60)](https://github.com/rl-institut/super-repo/pull/60)
 - Add CI-based automated testing and linting on commit and pull requests [(#55)](https://github.com/rl-institut/super-repo/pull/55)
+- Add license files to folder LICENSES [(#64)](https://github.com/rl-institut/super-repo/pull/64)
+- Add dep5 file for copyright notices [(#64)](https://github.com/rl-institut/super-repo/pull/64)
+- Add pre-commit hook for REUSE [(#64)](https://github.com/rl-institut/super-repo/pull/64)
+- Add copyright notice to all files [(#64)](https://github.com/rl-institut/super-repo/pull/64)
+- Add first version of pyproject.toml [(#64)](https://github.com/rl-institut/super-repo/pull/64)
 
 ### Changed
 
@@ -28,6 +38,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Disable GitHub Action for MkDocs Workflow [(#54)](https://github.com/rl-institut/super-repo/pull/54)
 - Remove merged documentation files [(#62)](https://github.com/rl-institut/super-repo/pull/62)
+- Remove the LICENSE.txt file [(#64)](https://github.com/rl-institut/super-repo/pull/64)
 
 ## [0.2.0] Minor Release - Oh Hi Mike - 2023-08-11
 

CITATION.cff

@@ -1,15 +1,23 @@
+# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+# SPDX-License-Identifier: CC0-1.0
+
 cff-version: 1.2.0
 message: "If you use this software, please cite it using these metadata."
 authors:
   - family-names: "Hülk"
     given-names: "Ludwig"
-    alias: "@Ludee"
+    alias: "Ludee"
     affiliation: "Reiner Lemoine Institut"
     orcid: "https://orcid.org/0000-0003-4655-2321"
+  - family-names: "Huber"
+    given-names: "Jonas"
+    alias: "jh-rli"
+    affiliation: "Reiner Lemoine Institut"
+    orcid: "https://orcid.org/0000-0002-6234-0751"
 title: "Super Repo"
 type: software
 license: MIT
 version: 0.2.0
-doi:
+doi: null
 date-released: 2023-08-11
 url: "https://github.com/rl-institut/super-repo/"

CODE_OF_CONDUCT.md

@@ -1,3 +1,8 @@
+<!--
+SPDX-FileCopyrightText: Coraline Ada Ehmke <https://where.coraline.codes/>
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge

CONTRIBUTING.md

@@ -1,5 +1,10 @@
-<!--SPDX-License-Identifier: MIT-->
-<!--Version: v1.0.0-->
+<!--
+SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+SPDX-License-Identifier: MIT
+
+[Homepage]: https://rl-institut.github.io/super-repo/
+[Version]: [Super-Repo v0.2.0](https://github.com/rl-institut/super-repo/releases)
+-->
 
 # Collaborative Development
 
@@ -71,6 +76,7 @@ git pull
 
 - production - includes the current stable version
 - develop - includes all current developments
+- gh-pages - Contains the compiled documentation
 
 #### 2.1. Create a new (local) branch
 

LICENSES/BSD-2-Clause.txt

@@ -0,0 +1,11 @@
+Note: This license has also been called the “Simplified BSD License” and the “FreeBSD License”. See also the 3-clause BSD License.
+
+Copyright <YEAR> <COPYRIGHT HOLDER>
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.