Zum Inhalt

Entwicklung

Lokale Entwicklungsumgebung für Beiträge zu gh-plumbing selbst.


Tooling

Das Projekt pinnt seine Tools mit asdf (.tool-versions).

asdf install

Damit werden act, python und task in den gepinnten Versionen installiert.


Übliche Tasks

Die geteilte Sammlung nolte/taskfiles liefert die Task-Definitionen.

task -l
task pre-commit:install   # Hooks registrieren
task pre-commit:start     # gegen alle Dateien ausführen
task mkdocs:start         # auf http://localhost:8001 serven

Ohne task

Wer rohe Kommandos bevorzugt:

virtualenv ~/.vens/development
source ~/.vens/development/bin/activate
pip install -r requirements-dev.txt
mkdocs serve -a localhost:8001

Workflows lokal ausführen

Mit nektos/act lassen sich GitHub Actions lokal ausführen:

act push -j static -W .github/workflows/build-static-tests.yaml

Prosa-Linting

Vale prüft Markdown-Dateien im CI über reusable-spelling-vale.yaml. Die Regeln liegen in .vale.ini, die Styles unter .github/styles/.

Vale überspringt CLAUDE.md

CLAUDE.md trägt Large-Language-Model-Kontext für Claude Code, keine Endnutzer-Dokumentation, deshalb überspringt Vale die Datei.