CONTRIBUTING.md

Contributing

Development setup

From the repository root:

python -m venv .venv
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
.\.venv\Scripts\Activate.ps1
python -m pip install -e .[dev]

On Linux or macOS:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install -e .[dev]

Running the CLI locally

komu --help
komu shell
komu providers list

Running tests

python -m compileall src
python -m unittest discover -s tests -p "test_*.py"

Contribution guidelines

• keep user-facing command text in English
• preserve the layered architecture between CLI, services, models, storage, providers, and SSH
• prefer small, typed, testable changes
• add or update tests when fixing command flows or pure services
• do not add repo-root runtime assumptions

Release-oriented changes

If you change packaging, install commands, or command discovery behavior:

• update README.md
• update docs/run-and-install.md
• update docs/windows-run-guide.md
• update path_route_md and path_route.md