Skip to content
SoundBlue Docs

Contributing Guidelines

Welcome

Thank you for your interest in contributing! This document outlines the guidelines for contributing to the project.

Code of Conduct

  • Be respectful and inclusive
  • Provide constructive feedback
  • Focus on technical merit

Getting Started

  1. Fork the repository on GitHub

  2. Clone your fork

    Terminal window
    git clone https://github.com/YOUR_USERNAME/public-monorepo.git

  3. Create a branch

    Terminal window
    git checkout -b feature/your-feature-name

  4. Make your changes and commit

    Terminal window
    git commit -m "feat: add your feature"

  5. Push and create a PR

    Terminal window
    git push origin feature/your-feature-name

Critical Rules

Commit Convention

Use conventional commits:

TypeDescription
featNew feature
fixBug fix
docsDocumentation
styleFormatting
refactorCode refactoring
testAdding tests
choreMaintenance

Example:

feat(context): add audio playback for entries
fix(roots): correct formula rendering
docs: update architecture documentation

Pull Request Process

  1. Ensure all tests pass
  2. Update documentation if needed
  3. Request review from maintainers
  4. Address feedback promptly

Quality Checks

Before submitting:

Terminal window
pnpm lint        # Check code style
pnpm typecheck   # Check types
pnpm test        # Run tests
pnpm build       # Verify build

Questions?

  • Open an issue on GitHub
  • Check existing documentation