Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (44 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

62 lines (44 loc) · 1.19 KB
Raw

Contributing

Thanks for contributing to K kode.

Before You Open A PR

  • keep changes scoped and intentional
  • prefer fixing one problem well over mixing unrelated changes
  • keep Windows-first behavior intact unless the change is explicitly about portability
  • do not commit secrets, API keys, or local session data

Local Setup

npm.cmd install
npm.cmd run check
npm.cmd run build

Run from source:

npm.cmd run dev

Run the built CLI:

npm.cmd run start

Contribution Priorities

  • terminal UX polish
  • runtime stability
  • editing safety
  • session quality
  • documentation clarity

PR Guidelines

  • describe the user-facing problem
  • describe the behavior change
  • mention any tradeoffs or known limitations
  • include validation steps you ran

Coding Notes

  • TypeScript project
  • Windows-first and PowerShell-first for now
  • Moonshot Kimi is the primary provider target
  • committed dist/ is intentional for alpha usability

Issues

When filing an issue, include:

  • Windows version
  • Node.js version
  • how you launched kk
  • the prompt or command that triggered the problem
  • whether KK_AUTO_APPROVE or KK_PROVIDER=mock was in use