Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (26 loc) · 674 Bytes

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 674 Bytes

Contributing

Thanks for your interest in CUTKIT.

Development setup

  1. Ensure uv is installed and Python 3.12+ is available.
  2. Bootstrap development tooling and run checks:
make dev
  1. Run checks manually as needed:
uv run prek run --all-files
  1. For feature work, use OpenSpec change artifacts:
/opsx-propose <idea>  # OpenCode
/opsx-apply <change>  # OpenCode
/opsx-archive <change>  # OpenCode

# Or namespace form in tools that support it:
/opsx:propose <idea>
/opsx:apply <change>
/opsx:archive <change>

Pull requests

  • Keep changes focused.
  • Add tests for new behavior.
  • Update docs when API behavior changes.