Skip to content

docs(seo): sharpen README + composer.json metadata, add doc-aware pre-push hook #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Headgent merged 1 commit into from
Jun 9, 2026
Merged

docs(seo): sharpen README + composer.json metadata, add doc-aware pre-push hook #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---

Expand Down
7 changes: 5 additions & 2 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,13 @@
"keywords": [
"workflow",
"orchestration",
"process-orchestration",
"state-machine",
"transitions",
"steps",
"domain-driven-design",
"php",
"jardis",
"Headgent",
"php"
"headgent"
]
}
8 changes: 8 additions & 0 deletions support/makefile/hooks.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading