Compare commits

..
1 Commits
Author SHA1 Message Date
Philipp 1eb05525c8 Do imporve the GEMINI.md
Lint / pre-commit Linting (push) Successful in 1m15s
2025-12-29 23:55:45 +01:00
4 changed files with 49 additions and 30 deletions

No files matched your search

+18
View File
@@ -0,0 +1,18 @@
name: Lint
on:
push:
workflow_dispatch:
jobs:
pre-commit-lint:
name: pre-commit Linting
runs-on: pi
steps:
- uses: actions/checkout@v6
- uses: actions/setup-python@v6
- run: pip install pre-commit
shell: bash
- name: Pre Commit
run: SKIP=no-commit-to-branch pre-commit run -a
shell: bash
+25 -15
View File
@@ -2,6 +2,10 @@ repos:
- repo: https://github.com/pre-commit/pre-commit-hooks - repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0 rev: v6.0.0
hooks: 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-yaml
- id: check-json - id: check-json
- id: check-toml - id: check-toml
@@ -24,13 +28,13 @@ repos:
- repo: https://github.com/astral-sh/ruff-pre-commit - repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version. # Ruff version.
rev: v0.17.0 rev: v0.14.10
hooks: hooks:
- id: ruff - id: ruff
args: [--fix, --exit-non-zero-on-fix] args: [--fix, --exit-non-zero-on-fix]
- repo: https://github.com/psf/black - repo: https://github.com/psf/black
rev: 26.10.1 rev: 25.12.0
hooks: hooks:
- id: black - id: black
args: [--config=pyproject.toml] args: [--config=pyproject.toml]
@@ -39,30 +43,39 @@ repos:
- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
rev: v2.16.0 rev: v2.15.0
hooks: hooks:
- id: pretty-format-ini
args: [--autofix]
- id: pretty-format-yaml - id: pretty-format-yaml
args: [--autofix] args: [--autofix]
- id: pretty-format-toml - id: pretty-format-toml
args: [--autofix] args: [--autofix]
exclude: (^poetry.lock$) exclude: (^poetry.lock$)
- repo: https://github.com/frnmst/md-toc
rev: 9.0.0
hooks:
- id: md-toc
- repo: https://github.com/Lucas-C/pre-commit-hooks-java
rev: 1.3.10
hooks:
- id: validate-html
- repo: https://github.com/MarcoGorelli/auto-walrus
rev: 0.3.4
hooks:
- id: auto-walrus
- repo: https://github.com/pre-commit/mirrors-prettier - repo: https://github.com/pre-commit/mirrors-prettier
rev: v4.0.0-alpha.8 rev: v4.0.0-alpha.8
hooks: hooks:
- id: prettier - id: prettier
types_or: [css, javascript] 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 - repo: https://github.com/python-jsonschema/check-jsonschema
rev: 0.38.2 rev: 0.36.0
hooks: hooks:
- id: check-jsonschema - id: check-jsonschema
name: Check Gitea Workflows name: Check Gitea Workflows
@@ -73,7 +86,6 @@ repos:
- id: check-compose-spec - id: check-compose-spec
- id: check-dependabot - 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 - repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0 rev: v6.0.0
hooks: hooks:
@@ -81,5 +93,3 @@ repos:
exclude: (.txt$|.ipynb$|README.md$|readme.mde$) exclude: (.txt$|.ipynb$|README.md$|readme.mde$)
- id: trailing-whitespace - id: trailing-whitespace
exclude: (.txt$|README.md$) exclude: (.txt$|README.md$)
- id: mixed-line-ending
args: [--fix=lf]
+5 -14
View File
@@ -4,20 +4,11 @@ This document outlines some basic rules and guidelines for development within th
## Development Guidelines ## 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:** Use 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 * Do NEVER skip the `pre-commits` via the git argument `-n`
- **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 ## 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`. The comparison should only move fitting changes to the current repo. * 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`.
+1 -1
View File
@@ -1,3 +1,3 @@
# template-git # template-git
A template for git repostories A template for git repostories