Skip to content

Contributing

NtGitG edited this page Jun 12, 2026 · 1 revision

Contributing

Small mod, small rules.

Workflow

  1. Branch from main (or optimisation if that is your active dev branch).
  2. Keep commits focused.
  3. Compile (and run tests if you touched core logic).
  4. Open a PR with what changed and how you tested it.

Minimum check

.\gradlew.bat compileJava --no-daemon

If you changed logic

.\gradlew.bat test --no-daemon

Tests live in src/test/java (parser, cache, storage, retry, API builders).

UI changes

Attach a screenshot in the PR if you changed a GUI screen.

Docs

User docs live on the GitHub wiki. Update the relevant wiki page if you add a command or config option.

Publish local wiki sources with:

.\scripts\publish-wiki.ps1

Clone this wiki locally