Contributing
Thanks for wanting to help. This section explains how FunkArr is built, run, tested and released. It does not repeat the code conventions: those live on anvil, with FunkArr as the reference implementation.
Ways to contribute
| You want to… | Start here | Needs C#? |
|---|---|---|
| Report a bug | Bug report form | No |
| Request a feature | Feature request form | No |
| Ask for a show or movie | Ruleset request form | No |
| Write or fix a ruleset | Rulesets | No |
| Improve the docs | Edit the page (link at the bottom of every page) | No |
| Fix a bug or build a feature | Local development, then Architecture | Yes |
Where the rules are
- anvil.st0o0.net explains the conventions with reasons and examples: C#, actors, persistence, APIs, testing, metrics.
AGENTS.mdin the repository root is the compact version of the same rules that AI agents load. If you change a convention, update it there in the same pull request.
Planning a change
Non-trivial changes are planned with OpenSpec before code is written. Current behavior is specified in openspec/specs/, proposals live in openspec/changes/<name>/ (proposal.md, design.md, specs/, tasks.md).
- Explore: think the problem through, read the code, compare options.
- Propose: write the change, check it with
openspec validate <name> --strict. - Apply: implement the tasks and tick them off.
- Archive: merge the delta specs into
openspec/specs/and move the change toopenspec/changes/archive/.
Typos, dependency bumps and obvious one-line fixes don't need a proposal.
Commits
Conventional Commits, checked by commitlint in CI. The type decides where the commit shows up in the changelog:
| Type | Changelog section |
|---|---|
feat | Features (for rulesets: New Rulesets) |
fix | Bug Fixes (for rulesets: Ruleset Fixes) |
perf, refactor, docs, deps | Performance, Refactoring, Documentation, Dependencies |
test, ci, build, chore, style | hidden |
Scopes are optional; use the domain or area, e.g. fix(arrapi): ….
Before you open a 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.csprojThe build must have zero warnings, and behavior changes come with tests. The pull request template has the full checklist; Building and testing lists what CI runs.
Code, specs, commits, issues and pull requests are in English. The docs exist in German and English, so docs changes go into both.
By contributing you agree to the Code of Conduct. Report security issues through SECURITY.md, not public issues.