Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (59 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

83 lines (59 loc) · 2.2 KB

Contributing to IntellyWeave CLI

Thank you for your interest in contributing!

For AI Coding Assistants: See CLAUDE.md for comprehensive technical documentation.

Quick Start

# Clone and install
git clone https://github.com/Intellyweave/intellyweave-cli.git
cd intellyweave-cli
npm install

# Configure
cp .env.example .env
# Edit .env with your credentials

# Build and test
npm run build
npm run test

Documentation

Guide Description
Development Setup Get your environment ready
Code Standards TypeScript patterns and conventions
Testing Running and writing tests
Publishing npm publishing process
Architecture Project structure and patterns

Development Workflow

  1. Create branch: git checkout -b feat/my-feature
  2. Make changes: Follow Code Standards
  3. Test: npm run check && npm run test
  4. Commit: Use Conventional Commits
  5. Pull request: Clear title and description

Key Concepts

Mutation Safety

All data-modifying operations require --live:

# Preview (safe)
intellyweave data import

# Execute
intellyweave --live data import

Use runMutation() helper for new mutations. See Mutation Safety Guide.

Scripts

npm run dev        # Run in development mode
npm run build      # Compile TypeScript
npm run check      # Lint + type check
npm run test       # Run all tests
npm run lint:fix   # Auto-fix lint issues

Pull Request Checklist

  • Code compiles: npm run build
  • Linting passes: npm run check
  • Tests pass: npm run test
  • Mutations use runMutation() helper
  • Documentation updated for new features

Getting Help

License

By contributing, you agree your contributions will be licensed under the MIT License.