From 52b3c8ad5800aa59d4f3a152af0429fe15de645f Mon Sep 17 00:00:00 2001 From: Headgent Date: Tue, 9 Jun 2026 15:35:07 +0200 Subject: [PATCH] docs(seo): sharpen README + composer.json metadata, add doc-aware pre-push hook (#7) --- README.md | 4 ++-- composer.json | 7 +++++-- support/makefile/hooks.mk | 8 ++++++++ 3 files changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5b1ac6b..14f0ac2 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ [![PSR-12](https://img.shields.io/badge/Code%20Style-PSR--12-blue.svg)](phpcs.xml) [![Coverage](https://img.shields.io/badge/Coverage-99.22%25-brightgreen.svg)](https://github.com/jardisSupport/workflow) -> Part of the **[Jardis Business Platform](https://jardis.io)** — Enterprise-grade PHP components for Domain-Driven Design +> Part of **[Jardis](https://jardis.io)** — the Domain-Driven Design platform for PHP. You model your domain; Jardis generates the production-ready hexagonal code (DTOs, Command/Query handlers, repositories, persistence). This package is part of the open-source foundation that generated code runs on. -Directed workflow engine for multi-step process orchestration. Define handler graphs with named transitions, propagate every step's result through a typed context, and wire it all up with a fluent builder API. Each handler returns a `WorkflowResult` whose status — one of seven `ON_*` constants — picks the next step. +Directed workflow engine for multi-step process orchestration in PHP. Define handler graphs with named transitions, propagate every step's result through a typed context, and wire it all up with a fluent API. Each handler returns a `WorkflowResult` whose status — one of seven `ON_*` constants — picks the next step. --- diff --git a/composer.json b/composer.json index 051c2e5..a9c006e 100644 --- a/composer.json +++ b/composer.json @@ -37,10 +37,13 @@ "keywords": [ "workflow", "orchestration", + "process-orchestration", "state-machine", "transitions", + "steps", + "domain-driven-design", + "php", "jardis", - "Headgent", - "php" + "headgent" ] } diff --git a/support/makefile/hooks.mk b/support/makefile/hooks.mk index fc38374..902809e 100644 --- a/support/makefile/hooks.mk +++ b/support/makefile/hooks.mk @@ -7,6 +7,14 @@ install-hooks: ## Install git hooks (pre-commit + pre-push) @echo '# Jardis Pre-Push Hook — Quality Gate' >> .git/hooks/pre-push @echo 'set -e' >> .git/hooks/pre-push @echo 'echo "=== Jardis Pre-Push Quality Gate ==="' >> .git/hooks/pre-push + @echo '# Doku-Fast-Path: keine *.php geaendert -> PHP-Gates ueberspringen (kein --no-verify, der Hook entscheidet korrekt)' >> .git/hooks/pre-push + @echo 'base="$$(git rev-parse --abbrev-ref --symbolic-full-name @{u} 2>/dev/null || echo origin/develop)"' >> .git/hooks/pre-push + @echo 'changed="$$(git diff --name-only "$$base"...HEAD 2>/dev/null)"' >> .git/hooks/pre-push + @echo 'if ! echo "$$changed" | grep -q "[.]php$$"; then' >> .git/hooks/pre-push + @echo ' echo ">>> Nur Doku/Metadaten geaendert (keine *.php) — phpcs/phpstan/phpunit uebersprungen"' >> .git/hooks/pre-push + @echo ' echo "=== Quality Gate (Doku-Fast-Path) bestanden ==="' >> .git/hooks/pre-push + @echo ' exit 0' >> .git/hooks/pre-push + @echo 'fi' >> .git/hooks/pre-push @echo 'echo ">>> make phpcs"' >> .git/hooks/pre-push @echo 'make phpcs || { echo "PHPCS fehlgeschlagen — Push abgebrochen"; exit 1; }' >> .git/hooks/pre-push @echo 'echo ">>> make phpstan"' >> .git/hooks/pre-push