Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (46 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

61 lines (46 loc) · 1.45 KB

Contributing to bestwork-agent

Thanks for your interest in contributing to bestwork-agent! Here's how to get started.

Development Setup

git clone https://github.com/rlaope/bestwork-agent.git
cd bestwork-agent
npm install
npm run build

Scripts

Command Description
npm run build Build with tsup
npm run dev Watch mode
npm test Run tests
npm run test:watch Watch tests
npm run typecheck Type check

Project Structure

src/
├── cli/           # CLI entry point & commands
├── ui/            # Ink TUI components
├── core/          # Analytics engine & types
├── data/          # Data parsers (~/.claude/)
└── utils/         # Formatting helpers

Guidelines

  • Write tests for new features
  • Run npm run typecheck before submitting
  • Keep PRs focused — one feature per PR
  • Use conventional commits (feat:, fix:, docs:, etc.)

Adding a New Command

  1. Create src/cli/commands/your-command.ts
  2. Register it in src/cli/index.ts
  3. Add tests if applicable

Adding a New Data Source

  1. Add parser in src/data/claude-parser.ts
  2. Add types in src/core/types.ts
  3. Integrate in src/core/aggregator.ts
  4. Write unit tests with mock data

Reporting Issues

Open an issue at https://github.com/rlaope/bestwork-agent/issues with:

  • What you expected
  • What happened
  • Steps to reproduce
  • bestwork-agent --version output