Files
alan/CONTRIBUTING.md
T

1.3 KiB

Contributing

Dieses Repo ist fuer eine Workstation-/Homelab-nahe Infrastruktur gedacht. Aenderungen sollten daher vor allem diese Ziele schuetzen:

  • reproduzierbares Verhalten
  • klare Trennung zwischen Hermes und OpenClaw
  • sichere Defaults
  • moeglichst wenig manuelle Nacharbeit nach Updates

Branching

  • main bleibt deploybar
  • neue Arbeit in feat/..., fix/..., docs/..., chore/...
  • Merge erst nach lokalem Check

Vor jedem Merge

./scripts/release-check
./scripts/alanctl validate
./scripts/alanctl doctor

Formatierung und Ownership

  • nutze einen Editor mit .editorconfig-Unterstuetzung
  • beachte CODEOWNERS und docs/maintainers.md bei Review und Zustaendigkeit
  • Aenderungen an Runtime-, Netz- oder Update-Logik nicht ohne bewusste Review freigeben

Commit-Stil

Empfohlen:

  • feat: ...
  • fix: ...
  • docs: ...
  • chore: ...
  • refactor: ...

Release-Regel

Jede aenderungsrelevante Anpassung an Compose, Skripten oder Netz-Logik braucht:

  • Eintrag in CHANGELOG.md
  • kurzen Hinweis in passender Doku
  • bei Upgrade-Auswirkung einen Eintrag in docs/upgrade-policy.md

Security-Meldungen

Bitte keine sicherheitsrelevanten Probleme oeffentlich als normales Issue posten. Nutze dafuer die Hinweise in SECURITY.md.