Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (26 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 1.17 KB
Raw

Contributing

Thanks for your interest in contributing to Cloud Code CLI.

Setup

git clone https://github.com/cloud-teahouse/cloud-code.git
cd cloud-code
pnpm install
pnpm build

Run the app in dev mode: pnpm -C apps/cloud-code run dev.

Before opening a PR

  • pnpm build passes
  • pnpm test passes (report load-sensitive flakes if any fail only under full-suite load)
  • pnpm run typecheck clean
  • pnpm lint introduces no new errors
  • New user-visible strings are localized (en + zh-CN)
  • New behavior comes with tests

Conventions

  • Read AGENTS.md first — layout, brand rules (including the Moonshot service contract), i18n, and comment style.
  • Keep diffs focused: one concern per PR.
  • Comments explain WHY, not WHAT; no plan/batch numbers or process narration.
  • Don't add dependencies without discussing it in an issue first.

Reporting issues

Please include: Cloud Code CLI version (cloudcode --version), OS/terminal, provider in use, and a minimal reproduction. Logs live under ~/.cloud-code/ — redact credentials before attaching.

Security

Do not open public issues for vulnerabilities — see SECURITY.md.