Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (35 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 1.7 KB
Raw

Contributing to Soku CLI

Thanks for your interest in improving the Soku CLI! This document covers how to get set up, the conventions we follow, and how to submit changes.

Getting started

git clone https://github.com/About-Intelligence/soku-cli.git
cd soku-cli
pnpm install
pnpm test

Development workflow

  • Type check: pnpm typecheck
  • Test: pnpm test (compiles with tsconfig.test.json, runs node --test)
  • Build: pnpm build
  • Keep changes surgical and focused. Match the surrounding code style.
  • All code, identifiers, and comments must be in English.

The generated capability manifest

src/generated/capabilities.json is the single source that drives the CLI's typed command tree. It is generated by the Soku backend, not in this repository, and is synced here automatically. Do not hand-edit it — a pull request that modifies it manually will be closed. If a capability is missing or wrong, open an issue describing the command and the expected behavior.

Commit and PR conventions

  • Use Conventional Commits for messages (feat:, fix:, chore:, docs:, refactor:, test: …).
  • One logical change per PR. Include tests for behavior changes.
  • Make sure pnpm typecheck && pnpm test pass before opening a PR.
  • Fill in the pull request template.

Reporting bugs / requesting features

Use the issue templates. For anything security-sensitive, follow SECURITY.md instead of opening a public issue.

Code of Conduct

This project follows the Contributor Covenant. By participating you agree to uphold it.