Fix pre-commit #24

rl-institut · Dec 6, 2024 · fe30aea · fe30aea
1 parent a954a0a
commit fe30aea
Show file tree

Hide file tree

Showing 15 changed files with 98 additions and 98 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -29,7 +29,7 @@ repos:
   - repo: https://github.com/google/pre-commit-tool-hooks
     rev: v1.2.5
     hooks:
-      - id: check-google-doc-style
+#      - id: check-google-doc-style
       - id: check-links
 
   # Ruff - Fast Python linter, written in Rust

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,87 +15,87 @@ 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-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)
+- 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 year of creation to copyright info [(#71)](https://github.com/rl-institut/super-repo/pull/71)
 
 ### Changed
 
-- 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)
-- Update documentation best-practices [(#72)](https://github.com/rl-institut/super-repository/pull/72)
+- 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 documentation best-practices [(#72)](https://github.com/rl-institut/super-repo/pull/72)
 
 ### Removed
 
-- 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)
+- 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
 
 ### Added
 
-- Add documentation version control with mike [(#47)](https://github.com/rl-institut/super-repository/pull/47)
+- Add documentation version control with mike [(#47)](https://github.com/rl-institut/super-repo/pull/47)
 
 ### Changed
 
-- Update issue templates and release procedure [(#47)](https://github.com/rl-institut/super-repository/pull/47)
+- Update issue templates and release procedure [(#47)](https://github.com/rl-institut/super-repo/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-repository/pull/43)
+- Add issue template for release `issue_template_release.md` [(#43)](https://github.com/rl-institut/super-repo/pull/43)
 
 ### Changed
 
-- Update the release procedure [(#43)](https://github.com/rl-institut/super-repository/pull/43)
+- Update the release procedure [(#43)](https://github.com/rl-institut/super-repo/pull/43)
 
 ## [0.1.0] Minor Release - Emmy Hennings Day - 2023-08-10
 
 ### Added
 
-- [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)
+- [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)
 
 ### Changed
 
-- 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)
+- 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)
 
 ### Removed
 
-- Remove the `src` folder [(#26)](https://github.com/rl-institut/super-repository/pull/26)
+- Remove the `src` folder [(#26)](https://github.com/rl-institut/super-repo/pull/26)
 
 ## [0.0.0] Initial Release - Hello Super-Repository - 2022-03-03
 
@@ -104,4 +104,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - GitHub repository
 - .gitignore
 - LICENSE (MIT License)
-- [GitHub Projects](https://github.com/rl-institut/super-repository/projects?type=classic) for software versioning
+- [GitHub Projects](https://github.com/rl-institut/super-repo/projects?type=classic) for software versioning
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,8 +2,8 @@
 SPDX-FileCopyrightText: 2022 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
 SPDX-License-Identifier: MIT
 
-[Homepage]: https://rl-institut.github.io/super-repository/
-[Version]: [Super-Repository v0.2.0](https://github.com/rl-institut/super-repository/releases)
+[Homepage]: https://rl-institut.github.io/super-repo/
+[Version]: [Super-Repository v0.2.0](https://github.com/rl-institut/super-repo/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-repository/blob/main/CODE_OF_CONDUCT.md). <br>
+This repository is following the [Contributor Covenant Code of Conduct](https://github.com/rl-institut/super-repo/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-repository/develop/development/git/)
+Choose a suitable [issue template](https://rl-institut.github.io/super-repo/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>

diff --git a/RELEASE_PROCEDURE.md b/RELEASE_PROCEDURE.md
@@ -2,8 +2,8 @@
 SPDX-FileCopyrightText: 2022 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
 SPDX-License-Identifier: MIT
 
-[Homepage]: https://rl-institut.github.io/super-repository/
-[Version]: [Super-Repository v0.2.0](https://github.com/rl-institut/super-repository/releases)
+[Homepage]: https://rl-institut.github.io/super-repo/
+[Version]: [Super-Repository v0.2.0](https://github.com/rl-institut/super-repo/releases)
 -->
 
 # Release Procedure
@@ -29,13 +29,13 @@ It always has the format `YYYY-MM-DD`, for example `2022-05-16`.
 Following the Semantic Versioning, different workflows for Major, Minor, or Patch
 releases are possible. <br>
 For Major and Minor releases, follow the complete workflow.<br>
-For a **Patch Release** (Hotfix), start at [section 3](https://github.com/rl-institut/super-repository/blob/production/RELEASE_PROCEDURE.md#4--create-a-draft-github-release).
+For a **Patch Release** (Hotfix), start at [section 3](https://github.com/rl-institut/super-repo/blob/production/RELEASE_PROCEDURE.md#4--create-a-draft-github-release).
 
 ### 1. 🐙 Create a `GitHub Project`
 
-- Create [New classic project](https://github.com/rl-institut/super-repository/projects?type=classic)
+- Create [New classic project](https://github.com/rl-institut/super-repo/projects?type=classic)
 - Use the project template _Automated kanban with reviews_
-- Named `super-repository-v0.1.0`
+- Named `super-repo-v0.1.0`
 - Add a meaningful description
 - Track project progress
 
@@ -61,7 +61,7 @@ For a **Patch Release** (Hotfix), start at [section 3](https://github.com/rl-ins
 ### 4. 🐙 Create a `Draft GitHub Release`
 
 - Start here for a **Patch Release** (Hotfix)
-- [Draft a new release](https://github.com/rl-institut/super-repository/releases/new)
+- [Draft a new release](https://github.com/rl-institut/super-repo/releases/new)
 - Enter the release version number `0.1.0` as title
 - Summarize key changes from changelog in the description
 
@@ -73,9 +73,9 @@ For a **Patch Release** (Hotfix), start at [section 3](https://github.com/rl-ins
 ```
 
 - Add a link to the `📝CHANGELOG.md`
-  - `**Complete changelog:** [CHANGELOG.md](https://github.com/rl-institut/super-repository/blob/production/CHANGELOG.md)`
+  - `**Complete changelog:** [CHANGELOG.md](https://github.com/rl-institut/super-repo/blob/production/CHANGELOG.md)`
 - Add a link to compare versions
-  - `**Compare versions:** [0.1.0 - 0.2.0](https://github.com/rl-institut/super-repository/compare/v0.1.0...v0.2.0)`
+  - `**Compare versions:** [0.1.0 - 0.2.0](https://github.com/rl-institut/super-repo/compare/v0.1.0...v0.2.0)`
 - **Save draft**
 
 ### 5. 💠 Create a `release` branch
@@ -115,7 +115,7 @@ For a **Patch Release** (Hotfix), start at [section 3](https://github.com/rl-ins
 
 - Checkout `production` branch and pull
 - Check existing tags `git tag -n`
-- Create new tag: `git tag -a v0.1.0 -m "super-repository Minor Release v0.1.0"`
+- Create new tag: `git tag -a v0.1.0 -m "super-repo Minor Release v0.1.0"`
 - This commit will be the final version for the release, breath three times and check again
 - Push tag: `git push --tags`
 

diff --git a/docs/development/best-practice/code_style.md b/docs/development/best-practice/code_style.md
@@ -8,14 +8,14 @@ Maintaining a consistent code style is crucial for the readability and
 maintainability of a Python project.
 
 We enforce most of the following guidelines in our
-[Continuous-Integration pipeline](https://rl-institut.github.io/super-repository/develop/development/continuous-integration/)
+[Continuous-Integration pipeline](https://rl-institut.github.io/super-repo/develop/development/continuous-integration/)
 that check the code automatically.
 
 ## 1. Installation
 
 Before contributing to the project, make sure you have the necessary tools
 installed for code style enforcement.
-We utilize [pre-commit](https://rl-institut.github.io/super-repository/develop/development/continuous-integration/)
+We utilize [pre-commit](https://rl-institut.github.io/super-repo/develop/development/continuous-integration/)
 to automate code checks before committing changes.
 
 ## 2. Code Formatting

diff --git a/docs/development/best-practice/index.md b/docs/development/best-practice/index.md
@@ -5,16 +5,16 @@ maintains consistency, and ensures reliability. <br>
 This section focuses on three key methodologies essential for maintaining
 high standards in a collaborative scientific software environment:
 
-- [**Continuous Integration (CI)**](https://rl-institut.github.io/super-repository/develop/development/continuous-integration/): <br>
+- [**Continuous Integration (CI)**](https://rl-institut.github.io/super-repo/develop/development/continuous-integration/): <br>
   Automating the integration of code changes to catch errors early and maintain a stable codebase.
   CI ensures that all contributions are rigorously tested and integrated seamlessly into the project.
 
-- [**Test-Driven Development (TDD)**](https://rl-institut.github.io/super-repository/develop/development/continuous-integration/): <br>
+- [**Test-Driven Development (TDD)**](https://rl-institut.github.io/super-repo/develop/development/continuous-integration/): <br>
   A methodology where tests are written before the actual code implementation. <br>
   TDD promotes robust and well-designed code by enforcing that each feature is accompanied by
   thorough testing from the outset.
 
-- [**Pre-commit Hooks (PCH)**](https://rl-institut.github.io/super-repository/develop/development/continuous-integration/): <br>
+- [**Pre-commit Hooks (PCH)**](https://rl-institut.github.io/super-repo/develop/development/continuous-integration/): <br>
   Tools to enforce code
   quality and consistency by running checks or scripts before changes are committed. <br>
   These hooks help identify issues early, improving code hygiene and reducing technical debt.

diff --git a/docs/development/collaboration/chat.md b/docs/development/collaboration/chat.md
@@ -9,7 +9,7 @@ To engage with the developer and user community, <br>
 login with an existing account (for example GitHub) or register a new account.
 
 The room name is:
-[Super-Repository:matrix.org](https://app.element.io/#/room/#super-repository:matrix.org). <br>
+[Super-Repository:matrix.org](https://app.element.io/#/room/#super-repo:matrix.org). <br>
 
 !!! note "Used Icons"
     🐙 GitHub | 💠 git | 📝 File | 💻 Command Line
diff --git a/docs/development/collaboration/code_of_conduct.md b/docs/development/collaboration/code_of_conduct.md
@@ -1,6 +1,6 @@
 # Code of Conduct
 
-This repository is following the [Contributor Covenant Code of Conduct](https://github.com/rl-institut/super-repository/blob/production/CODE_OF_CONDUCT.md). <br>
+This repository is following the [Contributor Covenant Code of Conduct](https://github.com/rl-institut/super-repo/blob/production/CODE_OF_CONDUCT.md). <br>
 
 Everyone is asked to be self-reflective and always maintain a good culture
 of discussion and active participation.