Skip to content

Contributing

Thank you for your interest in contributing to Sidekick Docker! This page mirrors the CONTRIBUTING.md in the repository.

Getting Started

Prerequisites

  • Node.js 20+
  • Docker running
  • VS Code 1.85+ (for extension development)

Development Setup

git clone https://github.com/cesarandreslopez/sidekick-docker.git
cd sidekick-docker
bash scripts/build-all.sh
npm test

Running Locally

  • TUI dashboard: ./sidekick-docker-cli/dist/sidekick-docker.mjs
  • VS Code extension: Open sidekick-docker-vscode/ in VS Code and press F5

Available Commands

npm run build              # Full build (shared -> cli -> vscode)
npm run build:shared       # Shared library only
npm run build:cli          # CLI only
npm run build:vscode       # VS Code extension only
npm test                   # Run all tests

Code Style

  • TypeScript strict mode everywhere
  • Vitest for testing, co-located .test.ts files
  • Conventional Commits for commit messages

Making Changes

  1. Create a feature branch from main
  2. Make your changes with clear commits
  3. Ensure all tests pass (npm test)
  4. Update documentation if needed
  5. Submit a PR with a clear description

Areas for Contribution

  • Test coverage improvements
  • New container actions (pause, unpause, attach)
  • Remote Docker host support
  • Documentation and developer experience
  • Bug fixes

Look for issues labeled good first issue for newcomers.

License

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