Skip to content

Contributing

Yogeswaran Amsavalli edited this page Oct 3, 2026 · 1 revision

Contributing

Thanks for helping. Keep changes small and focused.

  1. Open an issue first for anything bigger than a small fix, so you know it's wanted before you build it.
  2. Fork the repo and branch from main:
    • feature/<what> for something new
    • fix/<what> for a bug
    • docs/<what> for documentation
  3. Keep pull requests small. One change per PR is easier to review.
  4. Run the checks. Build Debug and Release and run every checks/*.cs. See Building and Checks.
  5. Open the PR against main. It needs one approval and is squash-merged.

Style

Match the code around you: its naming, its comment density, and comments that say why in plain sentences. Logic that can live without WPF does (like IslandTrigger), with cases in checks/.

Clayo reads ~/.claude/projects and never writes there. Keep it that way: Clayo's own files go in %LOCALAPPDATA%\Clayo.

Security issues

Don't open a public issue. Report it privately from the repo's Security tab (Report a vulnerability).

License

Clayo is MIT licensed. By contributing you agree your contribution is under the same license.

Clone this wiki locally