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 los | C# nötig? |
|---|---|---|
| einen Fehler melden | Fehlerbericht | Nein |
| eine Funktion vorschlagen | Funktionswunsch | Nein |
| eine Serie oder einen Film anfragen | Regelwerk-Anfrage | Nein |
| ein Regelwerk schreiben oder korrigieren | Regelwerke | Nein |
| die Doku verbessern | Seite bearbeiten (Link unten auf jeder Seite) | Nein |
| einen Fehler beheben oder eine Funktion bauen | Lokale Entwicklung, dann Architektur | Ja |
Wo die Regeln stehen
- anvil.st0o0.net erklärt die Konventionen mit Begründung und Beispielen: C#, Aktoren, Persistenz, APIs, Tests, Metriken.
AGENTS.mdim 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).
- Explore: Problem durchdenken, Code lesen, Optionen vergleichen.
- Propose: Änderung schreiben und mit
openspec validate <name> --strictprüfen. - Apply: Aufgaben umsetzen und abhaken.
- Archive: Delta-Specs in
openspec/specs/übernehmen und die Änderung nachopenspec/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:
| Typ | Changelog-Abschnitt |
|---|---|
feat | Features (bei Regelwerken: New Rulesets) |
fix | Bug Fixes (bei Regelwerken: Ruleset Fixes) |
perf, refactor, docs, deps | Performance, Refactoring, Documentation, Dependencies |
test, ci, build, chore, style | ausgeblendet |
Scopes sind optional; nimm die Domäne oder den Bereich, z. B. fix(arrapi): ….
Vor dem Pull Request
dotnet build src/FunkArr.slnx
dotnet format src/FunkArr.slnx --verify-no-changes
dotnet run --project src/FunkArr.<Domain>.Tests/FunkArr.<Domain>.Tests.csprojDer 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.