Contributing

Thank you for your interest in contributing to Clew Code.

Scope of Contributions

Contributions should be limited to material you have the right to submit and license.

Do not contribute:

• Proprietary source code
• Leaked or copied code
• Private documentation
• Credentials, API keys, tokens, or secrets
• Material copied from Anthropic's proprietary products or private services
• Code that violates third-party licenses or terms

Good First Issues

• Add a new provider adapter in src/services/ai/
• Write tests for untested tools
• Fix docs, add examples
• Build a plugin or MCP server
• Improve Windows support

Development Setup

Prerequisites

• Node.js >= 18.0.0
• Bun >= 1.0.0
• Git

Getting Started

git clone https://github.com/ClewCode/ClewCode.git
cd ClewCode
bun install
bun run build
bun run start

Development Commands

bun run dev              # Live reload with tsx
bun run build            # Build to dist/
bun test                 # Run tests (Vitest)
bun x tsc --noEmit       # Type-check
bun run check:ci         # Full CI check (lint + test + typecheck)

Code Style

This project uses Biome for formatting and linting:

bun run format           # Format code
bun run lint             # Lint code
bun run check            # Full check with auto-fix

CI Pipeline

• Pushing a v* tag triggers the release workflow
• CI runs: typecheck → build → GitHub Release → npm publish

License

Contributor-authored modifications and original additions may be licensed under the terms described in LICENSE.md. Read LICENSE.md and SECURITY.md before contributing.