Skip to content

Mitwirken ​

Schön, dass du helfen willst. Dieser Bereich erklärt, wie FunkArr gebaut, gestartet, getestet und veröffentlicht wird. Die Code-Konventionen stehen hier nicht noch einmal: Sie liegen auf anvil, mit FunkArr als Referenzimplementierung.

Wie du beitragen kannst ​

Du willst …Hier geht's losC# nötig?
einen Fehler meldenFehlerberichtNein
eine Funktion vorschlagenFunktionswunschNein
eine Serie oder einen Film anfragenRegelwerk-AnfrageNein
ein Regelwerk schreiben oder korrigierenRegelwerkeNein
die Doku verbessernSeite bearbeiten (Link unten auf jeder Seite)Nein
einen Fehler beheben oder eine Funktion bauenLokale Entwicklung, dann ArchitekturJa

Wo die Regeln stehen ​

  • anvil.st0o0.net erklärt die Konventionen mit Begründung und Beispielen: C#, Aktoren, Persistenz, APIs, Tests, Metriken.
  • AGENTS.md im Repository-Root ist die kompakte Fassung derselben Regeln, die KI-Agenten laden. Wenn du eine Konvention änderst, pass sie dort im selben Pull Request an.

Eine Änderung planen ​

Größere Änderungen werden mit OpenSpec geplant, bevor Code entsteht. Das aktuelle Verhalten ist in openspec/specs/ beschrieben, Vorschläge liegen in openspec/changes/<name>/ (proposal.md, design.md, specs/, tasks.md).

  1. Explore: Problem durchdenken, Code lesen, Optionen vergleichen.
  2. Propose: Änderung schreiben und mit openspec validate <name> --strict prüfen.
  3. Apply: Aufgaben umsetzen und abhaken.
  4. Archive: Delta-Specs in openspec/specs/ übernehmen und die Änderung nach openspec/changes/archive/ verschieben.

Tippfehler, Dependency-Updates und offensichtliche Einzeiler brauchen keinen Vorschlag.

Commits ​

Conventional Commits, geprüft von commitlint in der CI. Der Typ bestimmt, wo der Commit im Changelog landet:

TypChangelog-Abschnitt
featFeatures (bei Regelwerken: New Rulesets)
fixBug Fixes (bei Regelwerken: Ruleset Fixes)
perf, refactor, docs, depsPerformance, Refactoring, Documentation, Dependencies
test, ci, build, chore, styleausgeblendet

Scopes sind optional; nimm die Domäne oder den Bereich, z. B. fix(arrapi): ….

Vor dem Pull Request ​

bash
dotnet build src/FunkArr.slnx
dotnet format src/FunkArr.slnx --verify-no-changes
dotnet run --project src/FunkArr.<Domain>.Tests/FunkArr.<Domain>.Tests.csproj

Der Build muss ohne Warnungen durchlaufen, und Verhaltensänderungen kommen mit Tests. Die vollständige Checkliste steht in der Pull-Request-Vorlage; was die CI prüft, steht unter Bauen und testen.

Code, Specs, Commits, Issues und Pull Requests sind auf Englisch. Die Doku gibt es auf Deutsch und Englisch, Doku-Änderungen gehören also in beide Sprachen.

Mit deinem Beitrag akzeptierst du den Code of Conduct. Sicherheitsprobleme meldest du über SECURITY.md, nicht in öffentlichen Issues.