Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 14 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,23 @@ Format: [Semantic Versioning](https://semver.org). Dates: YYYY-MM-DD.

## [Unreleased]

---

## [2.0.0] — 2026-06-08

### Added

- `design-iac`: Infrastructure as Code design grounded in Kief Morris "Infrastructure as Code" (O'Reilly 2021) and NTNU IIKG3005 — IaC principles (immutable infra, idempotency, snowflake anti-pattern), module design, remote state management, drift detection and remediation, GitOps workflow, IaC testing (3 reference files)
- `tool-perf`: Performance engineering grounded in MIT 6.172 (Leiserson/Shun, Bentley Rules) and Brendan Gregg "Systems Performance" (USE Method, flamegraphs) — USE Method resource checklist, profiling tool selection by stack, flamegraph reading guide, Bentley Rules (5 categories), before/after benchmark workflow (3 reference files)
- `design-migration` — schema evolution: Added Kleppmann "Designing Data-Intensive Applications" Kap. 4+11 coverage — Forward/Backward Compatibility rules, Dual-Write problem and solutions, Change Data Capture (CDC/Debezium), Avro Schema Registry, Expand-Contract pattern; new `references/schema-evolution.md`
- plugin.json: 22 → 24 skills (v1.2.0 → v1.3.0); meta-help renumbered 1–24
- plugin.json: 22 → 24 skills, v1.2.0 → v2.0.0; meta-help renumbered 1–24
- `docs/skill-research-basis.md`: new reference document — academic & industry sources per skill (replaces work-in-progress `docs/academic-basis.md`)
- CLAUDE.md: updated to reflect full plugin structure (24 skills, docs/ directory, plugin install command)

### Removed

- `docs/gap-analysis.md`: all items resolved — content lives in Git history
- `docs/academic-basis.md`: replaced by `docs/skill-research-basis.md`

- `design-observability`: Observability architecture skill grounded in Google SRE Books (Beyer et al.) and Observability Engineering (Majors/Fong-Jones) — SLO/SLI/Error-Budget, Golden Signals, OpenTelemetry tracing, Burn Rate alerting, Incident Response + blameless postmortem (4 reference files)
- `design-cicd`: CI/CD pipeline design grounded in "Accelerate" (Forsgren/Humble/Kim) and "Continuous Delivery" (Humble/Farley) — pipeline architecture, Blue-Green/Canary/Feature Flags decision tree, DORA metrics with benchmarks, Trunk-Based Development (3 reference files)
Expand Down Expand Up @@ -92,7 +103,8 @@ Format: [Semantic Versioning](https://semver.org). Dates: YYYY-MM-DD.

---

[Unreleased]: https://github.com/gerfru/dev-best-practices/compare/v1.2.0...HEAD
[Unreleased]: https://github.com/gerfru/dev-best-practices/compare/v2.0.0...HEAD
[2.0.0]: https://github.com/gerfru/dev-best-practices/compare/v1.2.0...v2.0.0
[1.2.0]: https://github.com/gerfru/dev-best-practices/compare/v1.1.0...v1.2.0
[1.1.0]: https://github.com/gerfru/dev-best-practices/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/gerfru/dev-best-practices/releases/tag/v1.0.0
68 changes: 43 additions & 25 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,65 @@
# Dev Best Practices

Dieses Repo enthaelt Best-Practice-Regeln fuer Software-Projekte -- typischerweise groessere Applikationen (RAG-Systeme, AI Agents, Data Pipelines, etc.) mit Web-Frontend.
Drei Stufen: **Essential** (kompakt, fuer CLAUDE.md), **Thematisch** (ausfuehrlichere Regeln), **Reference** (detailliert, fuer Menschen).
Dieses Repo enthaelt Best-Practice-Regeln fuer Software-Projekte (RAG-Systeme, AI Agents, Data Pipelines, Full-Stack Web Apps) und ein **Claude Code Plugin** mit 24 Skills.

## Repo-Struktur

```text
reference/ # Detaillierte Dokumentation zum Nachschlagen
app-best-practices.md # Security, Auth, API, DB, Monitoring, OWASP
github-best-practices.md # CI/CD, Linting, Testing, Docker, Code Review
architecture-best-practices.md # Schichten, Patterns, Infra, 12-Factor

claude/ # Kondensierte Regeln fuer Claude Code / Vibe-Coding
essential-rules.md # ~80 Zeilen -- in Projekt-CLAUDE.md einfuegen
app-rules.md # ~170 Zeilen (aus 860)
github-rules.md # ~210 Zeilen (aus 780)
architecture-rules.md # ~190 Zeilen (aus 1180)
.claude-plugin/
marketplace.json # Macht dieses Repo als Marketplace installierbar

plugins/dev/
.claude-plugin/
plugin.json # Plugin-Metadaten (name: "dev", version: "2.0.0")
commands/ # Slash-Command-Definitionen (eine Datei pro Skill)
skills/ # Skill-Workflow-Definitionen (auto-triggered)
rules/ # Mirror von claude/*.md (wird von Skills als Referenz genutzt)

claude/ # Kondensierte Regeln fuer Claude Code
essential-rules.md # ~80 Zeilen -- in Projekt-CLAUDE.md einfuegen
app-rules.md # App-Regeln im Detail
github-rules.md # GitHub / CI-Regeln im Detail
architecture-rules.md # Architektur-Regeln im Detail

reference/ # Detaillierte Dokumentation zum Nachschlagen
app-best-practices.md # Security, Auth, API, DB, Monitoring, OWASP
github-best-practices.md # CI/CD, Linting, Testing, Docker, Code Review
architecture-best-practices.md # Schichten, Patterns, Infra, 12-Factor

docs/
skill-research-basis.md # Akademische & Industrie-Quellen pro Skill

scripts/
validate-skills.sh # Plugin-Struktur-Validator (CI + pre-commit)
```

## Verwendung in Projekten

### Standard: essential-rules.md in Projekt-CLAUDE.md kopieren
## Plugin-Skills (24)

Reicht fuer die meisten Projekte. ~80 Zeilen, kompakt genug neben projektspezifischem Kontext.
```text
DESIGN: design-app, design-secure, design-api, design-data, design-migration,
design-ux, design-llm, design-observability, design-cicd, design-iac
REVIEW: review-app, review-arch, review-secure, review-ux, review-llm
TOOLS: tool-debug, tool-test, tool-style, tool-a11y, tool-perf
META: meta-help, meta-install, meta-drift, meta-sync, meta-create-skill
```

### Mehr Detail noetig?
Navigationsmenue: `/dev:meta-help`

Einzelne Sections aus den thematischen Files (`app-rules.md`, `github-rules.md`, `architecture-rules.md`) selektiv ergaenzen.
## Verwendung in Projekten

### Global (optional)
**Plugin installieren:** `claude plugin install dev@gerald-dev-best-practices`

Regeln die IMMER gelten in `~/.claude/CLAUDE.md` ablegen:
**Nur Regeln (ohne Plugin):** `claude/essential-rules.md` in Projekt-CLAUDE.md kopieren, oder `/dev:meta-install` verwenden.

- Linting/Formatting-Standards
- Git-Workflow
- Security-Grundregeln
**Mehr Detail:** Sections aus `claude/app-rules.md`, `claude/github-rules.md`, `claude/architecture-rules.md` selektiv ergaenzen.

## Pflege

- `reference/` aktualisieren wenn sich Best Practices aendern
- `claude/` synchron halten (nur Regeln, keine Erklaerungen)
- `essential-rules.md` ist die Single Source of Truth fuer das Kompaktformat
- Nach Regel-Aenderungen Mirror aktualisieren: `cp claude/*.md plugins/dev/rules/`
- Mirror aktualisieren nach Regel-Aenderungen: `cp claude/*.md plugins/dev/rules/`
- Neuen Skill hinzufuegen: `/dev:meta-create-skill`
- Quellen und akademische Basis: `docs/skill-research-basis.md`

<!-- DEV-BEST-PRACTICES:START — via /dev-best-practices:meta-install aktualisieren -->
<!-- Version: essential-rules.md @ 2026-06-08 | Umfang: essential | Vorher: 2026-06-05 -->
Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ Or just describe what you need in natural language — Claude picks the right sk

plugins/dev/
.claude-plugin/
plugin.json Plugin metadata (name: "dev")
commands/ Slash-command definitions
plugin.json Plugin metadata (name: "dev", version: "2.0.0")
commands/ Slash-command definitions (one file per skill)
skills/ Skill workflow definitions (auto-triggered)
rules/ Mirror of claude/*.md (used by skills as reference)

Expand All @@ -101,6 +101,9 @@ reference/ Detailed docs for humans
github-best-practices.md CI/CD, linting, testing, Docker, code review
architecture-best-practices.md Layers, patterns, infra, 12-Factor

docs/
skill-research-basis.md Academic & industry sources per skill

scripts/
validate-skills.sh Plugin structure validator (CI + pre-commit)
```
Expand Down
Loading
Loading