Contributing

February 22, 2026 ยท View on GitHub

Guide for contributing to HushBox.


Prerequisites

  • Node.js 20+ - Download
  • pnpm 10.26.0 - Install with npm install -g pnpm@10.26.0
  • Docker - Download

Quick Start

git clone https://github.com/LOME-AI/HushBox.git
cd hushbox
pnpm install
pnpm dev

This starts Docker services, runs migrations, and launches all dev servers.


Documentation


Pull Request Process

  1. Create a branch or fork from main
  2. Make changes with tests
  3. Ensure all checks pass (pnpm lint && pnpm typecheck && pnpm test)
  4. Submit PR with clear description
  5. Address review feedback
  6. HushBox team runs "pr test" for integration tests
  7. Merge when approved

Contributor Assignment Agreement

All contributors must sign our Contributor Assignment Agreement before pull requests can be merged:

  • Individual contributors: When you open your first pull request, the CLA Assistant bot will comment with a link to review and sign the Individual CAA. You only need to sign once.
  • Company contributors: If you are contributing on behalf of an employer or organization, contact legal@hushbox.ai to arrange Entity CAA signing before submitting contributions.

If you have questions about the agreement, contact legal@hushbox.ai before submitting a contribution.


Questions?

  • Open an issue for bugs or feature requests
  • Email hello@hushbox.ai for other inquiries