.pre-commit-config.yaml

@@ -2,10 +2,6 @@ repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v6.0.0
   hooks:
-  - id: end-of-file-fixer
-    exclude: (.txt$|.ipynb$|README.md$|readme.mde$)
-  - id: trailing-whitespace
-    exclude: (.txt$|README.md$)
   # - id: check-yaml
   - id: check-json
   - id: check-toml
@@ -74,6 +70,14 @@ repos:
   - id: prettier
     types_or: [css, javascript]
 
+- repo: https://github.com/executablebooks/mdformat
+  rev: 1.0.0  # Check for the latest version
+  hooks:
+  - id: mdformat
+    # Important: The GFM plugin is required for table support
+    additional_dependencies:
+    - mdformat-gfm
+
 - repo: https://github.com/python-jsonschema/check-jsonschema
   rev: 0.36.0
   hooks:
@@ -86,6 +90,7 @@ repos:
   - id: check-compose-spec
   - id: check-dependabot
 
+# the following hooks should always be at the end fo the file since they may add to what other hooks do
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v6.0.0
   hooks:
@@ -93,3 +98,5 @@ repos:
     exclude: (.txt$|.ipynb$|README.md$|readme.mde$)
   - id: trailing-whitespace
     exclude: (.txt$|README.md$)
+  - id: mixed-line-ending
+    args: [--fix=lf]

GEMINI.md

@@ -4,9 +4,20 @@ This document outlines some basic rules and guidelines for development within th
 
 ## Development Guidelines
 
-*   **Test-Driven Development (TDD):** Wherever possible, Test-Driven Development principles should be followed. Write tests before writing the code they are intended to validate.
+- **Test-Driven Development (TDD):** Wherever possible, Test-Driven Development principles should be followed. Write tests before writing the code they are intended to validate.
-*   **Pre-commit Hooks:** Ensure that `pre-commit` hooks are installed and active before making any commits. This can be done by running `pre-commit install` in your local repository.
+- **Pre-commit Hooks:** Ensure that `pre-commit` hooks are installed and active before making any commits. This can be done by running `pre-commit install` in your local repository.
+
+## Issue Management
+
+- **Closing Issues:** When a commit fixes or closes an issue, the commit message must include a supported keyword followed by the issue number (e.g., `fixes #123`, `closes #456`).
+  - Supported keywords: `close`, `closes`, `closed`, `fix`, `fixes`, `fixed`, `resolve`, `resolves`, `resolved`.
+  - **Placement:** This pattern should always be placed at the very end of the commit body (not the subject line).
+
+## PRs
+
+Do create PRs only on a specific user request. Do not create them on your own initiative.
+A PR should always contain a note if an issue is closed with it.
 
 ## Repository Comparison
 
-*   On request, this repository should be compared against the rules and guidelines specified in the `README.md` of the reference repository: `https://git.horstenkamp.eu/Philipp/template-git`.
+- On request, this repository should be compared against the rules and guidelines specified in the `README.md` of the reference repository: `https://git.horstenkamp.eu/Philipp/template-git`. The comparison should only move fitting changes to the current repo.

README.md

@@ -1,3 +1,3 @@
 # template-git
 
-A template for git repostories
+A template for git repostories