Merge pull request #71 from rl-institut/feature-70-reuse-year

Add year of creation to copyright info

.github/workflows/automated-testing.yml

@@ -1,5 +1,5 @@
-# SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
-# SPDX-FileCopyrightText: Jonas Huber <@jh-RLI> © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: 2023 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: 2023 Jonas Huber <https://github.com/jh-rli> © Reiner Lemoine Institut
 # SPDX-License-Identifier: MIT
 
 name: automated-testing

.github/workflows/codecov.yml

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: 2024 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
 # SPDX-License-Identifier: MIT
 
 name: codecov

.github/workflows/documentation.yml

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: 2023 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
 # SPDX-License-Identifier: MIT
 
 name: documentation (develop branch)

.github/workflows/reuse.yml

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: 2024 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
 # SPDX-License-Identifier: MIT
 
 name: REUSE compliance check

.gitignore

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: : Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: : 2022 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
 # SPDX-License-Identifier: CC0-1.0
 # Source: https://github.com/github/gitignore/blob/main/Python.gitignore
 

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: 2024 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
 #
 # SPDX-License-Identifier: MIT
 
@@ -13,7 +13,6 @@ repos:
       - id: check-yaml
       - id: check-json
       - id: check-toml
-      - id: check-xml
       - id: end-of-file-fixer
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
@@ -27,6 +26,12 @@ repos:
       - id: check-docstring-first
       - id: detect-private-key
 
+  - repo: https://github.com/google/pre-commit-tool-hooks
+    rev: v1.2.5
+    hooks:
+      - id: check-google-doc-style
+      - id: check-links
+
   # Ruff - Fast Python linter, written in Rust
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: 'v0.8.1'
@@ -44,19 +49,12 @@ repos:
         - 'sqlalchemy'
         - 'types-requests'
 
-  # mirrors-prettier - Formatting for other files then python scripts
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: 'v3.1.0'
-    hooks:
-    - id: prettier
-      files: \.(css|less|md|json|sql)$
-
-  # Numpy's Sphinx extensions
-  - repo: https://github.com/numpy/numpydoc
-    rev: v1.8.0
-    hooks:
-      - id: numpydoc-validation
-        exclude: (tests|docs)/.*
+#  # Numpy's Sphinx extensions
+#  - repo: https://github.com/numpy/numpydoc
+#    rev: v1.8.0
+#    hooks:
+#      - id: numpydoc-validation
+#        exclude: (tests|docs)/.*
 
   # REUSE Software - Make licensing easy for humans and machines alike
   - repo: https://github.com/fsfe/reuse-tool

CHANGELOG.md

@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
+SPDX-FileCopyrightText: 2022 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
 SPDX-License-Identifier: CC0-1.0
 -->
 
@@ -15,91 +15,92 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add a favicon for the documentation [(54#)](https://github.com/rl-institut/super-repo/pull/54)
-- Add a warning for older versions that links to latest [(#54)](https://github.com/rl-institut/super-repo/pull/54)
-- Add pre-commit and setup pre-commit-hooks [(#56)](https://github.com/rl-institut/super-repo/pull/56)
-- 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)
-- Add documentation for code style [(#63)](https://github.com/rl-institut/super-repo/pull/63)
-- Update REUSE [(#66)](https://github.com/rl-institut/super-repo/pull/66)
-- Add workflow with codecov [(#68)](https://github.com/rl-institut/super-repo/pull/68)
-- Add badges for publication section [(#69)](https://github.com/rl-institut/super-repo/pull/69)
+- Add a favicon for the documentation [(54#)](https://github.com/rl-institut/super-repository/pull/54)
+- Add a warning for older versions that links to latest [(#54)](https://github.com/rl-institut/super-repository/pull/54)
+- Add pre-commit and setup pre-commit-hooks [(#56)](https://github.com/rl-institut/super-repository/pull/56)
+- Add a community chat on Element [(#59)](https://github.com/rl-institut/super-repository/pull/59)
+- Add documentation on the regular community meetings [(#60)](https://github.com/rl-institut/super-repository/pull/60)
+- Add CI-based automated testing and linting on commit and pull requests [(#55)](https://github.com/rl-institut/super-repository/pull/55)
+- Add license files to folder LICENSES [(#64)](https://github.com/rl-institut/super-repository/pull/64)
+- Add dep5 file for copyright notices [(#64)](https://github.com/rl-institut/super-repository/pull/64)
+- Add pre-commit hook for REUSE [(#64)](https://github.com/rl-institut/super-repository/pull/64)
+- Add copyright notice to all files [(#64)](https://github.com/rl-institut/super-repository/pull/64)
+- Add first version of pyproject.toml [(#64)](https://github.com/rl-institut/super-repository/pull/64)
+- Add documentation for code style [(#63)](https://github.com/rl-institut/super-repository/pull/63)
+- Update REUSE [(#66)](https://github.com/rl-institut/super-repository/pull/66)
+- Add workflow with codecov [(#68)](https://github.com/rl-institut/super-repository/pull/68)
+- Add badges for publication section [(#69)](https://github.com/rl-institut/super-repository/pull/69)
+- Add year of creation to copyright info [(#71)](https://github.com/rl-institut/super-repository/pull/71)
 
 ### Changed
 
-- Update CSS to improve toc [(#54)](https://github.com/rl-institut/super-repo/pull/54)
-- Update documentation for mike [(#54)](https://github.com/rl-institut/super-repo/pull/54)
-- Update GitHub Action for develop branch [(#58)](https://github.com/rl-institut/super-repo/pull/58)
-- Update the sections and merge subpages of the documentation [(#62)](https://github.com/rl-institut/super-repo/pull/62)
-- Update documentation for release [(#69)](https://github.com/rl-institut/super-repo/pull/69)
+- Update CSS to improve toc [(#54)](https://github.com/rl-institut/super-repository/pull/54)
+- Update documentation for mike [(#54)](https://github.com/rl-institut/super-repository/pull/54)
+- Update GitHub Action for develop branch [(#58)](https://github.com/rl-institut/super-repository/pull/58)
+- Update the sections and merge subpages of the documentation [(#62)](https://github.com/rl-institut/super-repository/pull/62)
+- Update documentation for release [(#69)](https://github.com/rl-institut/super-repository/pull/69)
 
 ### Removed
 
-- 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)
+- Disable GitHub Action for MkDocs Workflow [(#54)](https://github.com/rl-institut/super-repository/pull/54)
+- Remove merged documentation files [(#62)](https://github.com/rl-institut/super-repository/pull/62)
+- Remove the LICENSE.txt file [(#64)](https://github.com/rl-institut/super-repository/pull/64)
 
 ## [0.2.0] Minor Release - Oh Hi Mike - 2023-08-11
 
 ### Added
 
-- Add documentation version control with mike [(#47)](https://github.com/rl-institut/super-repo/pull/47)
+- Add documentation version control with mike [(#47)](https://github.com/rl-institut/super-repository/pull/47)
 
 ### Changed
 
-- Update issue templates and release procedure [(#47)](https://github.com/rl-institut/super-repo/pull/47)
+- Update issue templates and release procedure [(#47)](https://github.com/rl-institut/super-repository/pull/47)
 
 ## [0.1.1] Patch Release - Emmy Hennings Day Patch - 2023-08-10
 
 ### Added
 
-- Add issue template for release `issue_template_release.md` [(#43)](https://github.com/rl-institut/super-repo/pull/43)
+- Add issue template for release `issue_template_release.md` [(#43)](https://github.com/rl-institut/super-repository/pull/43)
 
 ### Changed
 
-- Update the release procedure [(#43)](https://github.com/rl-institut/super-repo/pull/43)
+- Update the release procedure [(#43)](https://github.com/rl-institut/super-repository/pull/43)
 
 ## [0.1.0] Minor Release - Emmy Hennings Day - 2023-08-10
 
 ### Added
 
-- [LICENSE.txt](https://github.com/rl-institut/super-repo/blob/main/LICENSE.txt)
-- CITATION.cff [(#2)](https://github.com/rl-institut/super-repo/pull/2)
-- CONTRIBUTING.md [(#2)](https://github.com/rl-institut/super-repo/pull/2)
-- USERS.cff [(#2)](https://github.com/rl-institut/super-repo/pull/2)
-- CODE_OF_CONDUCT.md [(#3)](https://github.com/rl-institut/super-repo/pull/3)
-- CHANGELOG.md [(#6)](https://github.com/rl-institut/super-repo/pull/6)
-- README.rst [(#10)](https://github.com/rl-institut/super-repo/pull/10)
-- Add a logo to the README [(#18)](https://github.com/rl-institut/super-repo/pull/18)
-- Add mkdocstrings [(#20)](https://github.com/rl-institut/super-repo/pull/20)
-- Add example code with google docstrings [(#20)](https://github.com/rl-institut/super-repo/pull/20)
-- Add `requirements.txt` for python environment dependencies [(#20)](https://github.com/rl-institut/super-repo/pull/20)
-- Add templates for issues and PR [(#15)](https://github.com/rl-institut/super-repo/pull/15)
-- Add a GitHub workflow to deploy documentation [(#25)](https://github.com/rl-institut/super-repo/pull/25)
-- Add permanent links for documentation sections [(#28)](https://github.com/rl-institut/super-repo/pull/28)
-- Add documentation on documentation files [(#35)](https://github.com/rl-institut/super-repo/pull/35
-- Add `RELEASE_PROCEDURE.md` [(#37)](https://github.com/rl-institut/super-repo/pull/37)
+- [LICENSE.txt](https://github.com/rl-institut/super-repository/blob/main/LICENSE.txt)
+- CITATION.cff [(#2)](https://github.com/rl-institut/super-repository/pull/2)
+- CONTRIBUTING.md [(#2)](https://github.com/rl-institut/super-repository/pull/2)
+- USERS.cff [(#2)](https://github.com/rl-institut/super-repository/pull/2)
+- CODE_OF_CONDUCT.md [(#3)](https://github.com/rl-institut/super-repository/pull/3)
+- CHANGELOG.md [(#6)](https://github.com/rl-institut/super-repository/pull/6)
+- README.rst [(#10)](https://github.com/rl-institut/super-repository/pull/10)
+- Add a logo to the README [(#18)](https://github.com/rl-institut/super-repository/pull/18)
+- Add mkdocstrings [(#20)](https://github.com/rl-institut/super-repository/pull/20)
+- Add example code with google docstrings [(#20)](https://github.com/rl-institut/super-repository/pull/20)
+- Add `requirements.txt` for python environment dependencies [(#20)](https://github.com/rl-institut/super-repository/pull/20)
+- Add templates for issues and PR [(#15)](https://github.com/rl-institut/super-repository/pull/15)
+- Add a GitHub workflow to deploy documentation [(#25)](https://github.com/rl-institut/super-repository/pull/25)
+- Add permanent links for documentation sections [(#28)](https://github.com/rl-institut/super-repository/pull/28)
+- Add documentation on documentation files [(#35)](https://github.com/rl-institut/super-repository/pull/35
+- Add `RELEASE_PROCEDURE.md` [(#37)](https://github.com/rl-institut/super-repository/pull/37)
 
 ### Changed
 
-- Update the .gitignore [(#19)](https://github.com/rl-institut/super-repo/pull/19)
-- Update the documentation file structure [(#28)](https://github.com/rl-institut/super-repo/pull/28)
+- Update the .gitignore [(#19)](https://github.com/rl-institut/super-repository/pull/19)
+- Update the documentation file structure [(#28)](https://github.com/rl-institut/super-repository/pull/28)
 
 ### Removed
 
-- Remove the `src` folder [(#26)](https://github.com/rl-institut/super-repo/pull/26)
+- Remove the `src` folder [(#26)](https://github.com/rl-institut/super-repository/pull/26)
 
-## [0.0.0] Initial Release - Hello Super-Repo - 2022-03-03
+## [0.0.0] Initial Release - Hello Super-Repository - 2022-03-03
 
 ### Added
 
 - GitHub repository
 - .gitignore
 - LICENSE (MIT License)
-- [GitHub Projects](https://github.com/rl-institut/super-repo/projects?type=classic) for software versioning
+- [GitHub Projects](https://github.com/rl-institut/super-repository/projects?type=classic) for software versioning

CITATION.cff

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: 2022 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
 # SPDX-License-Identifier: CC0-1.0
 
 cff-version: 1.2.0

CODE_OF_CONDUCT.md

@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: Coraline Ada Ehmke <https://where.coraline.codes/>
+SPDX-FileCopyrightText: © 2014 Coraline Ada Ehmke <https://where.coraline.codes/>
 SPDX-License-Identifier: CC-BY-4.0
 -->
 
@@ -58,7 +58,7 @@ decisions when appropriate.
 This Code of Conduct applies within all community spaces, and also applies when
 an individual is officially representing the community in public spaces.
 Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
+posting by way of an official social media account, or acting as an appointed
 representative at an online or offline event.
 
 ## Enforcement

CONTRIBUTING.md

@@ -1,9 +1,9 @@
 <!--
-SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
+SPDX-FileCopyrightText: 2022 Ludwig Hülk <https://github.com/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)
+[Homepage]: https://rl-institut.github.io/super-repository/
+[Version]: [Super-Repository v0.2.0](https://github.com/rl-institut/super-repository/releases)
 -->
 
 # Collaborative Development
@@ -15,7 +15,7 @@ SPDX-License-Identifier: MIT
 
 ## Types of interaction
 
-This repository is following the [Contributor Covenant Code of Conduct](https://github.com/rl-institut/super-repo/blob/main/CODE_OF_CONDUCT.md). <br>
+This repository is following the [Contributor Covenant Code of Conduct](https://github.com/rl-institut/super-repository/blob/main/CODE_OF_CONDUCT.md). <br>
 Please be self-reflective and always maintain a good culture of discussion and active participation.
 
 ### A. Use
@@ -50,7 +50,7 @@ The workflow for contributing to this project has been inspired by the workflow
 
 Create [an issue](https://help.github.com/en/articles/creating-an-issue)
 in the GitHub repository. <br>
-Choose a suitable [issue template](https://rl-institut.github.io/super-repo/develop/development/git/)
+Choose a suitable [issue template](https://rl-institut.github.io/super-repository/develop/development/git/)
 for a `feature` or a `bug` and fill in as much information as possible.
 Most important is the `issue title`, it describes the problem you will address. <br>
 Update the `GitHub Labels` and assign to a `GitHub Project` and `Milestone` <br>
@@ -121,7 +121,7 @@ Examples of branch names: `feature-42-add-new-ontology-class`, `feature-911-bran
 - Don't rush, have the commit messages in mind
 - Add your changes to the CHANGELOG.md
 
-On first commit to the repo:
+On first commit to the repository:
 
 - Add your name and details to CITATION.cff
 

MANIFEST.in

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: 2024 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
 # SPDX-License-Identifier: MIT
 
 exclude .gitignore

README.rst

@@ -1,5 +1,5 @@
 ..
-  SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
+  SPDX-FileCopyrightText: 2022 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
 
   SPDX-License-Identifier: MIT