Skip to content

Contributing

Jump to bottom
Travis Van Nimwegen edited this page Jun 22, 2025 · 2 revisions

Contributing

Thank you for your interest in contributing to chatterbox-tts-api! We welcome all kinds of contributions, whether you're fixing bugs, adding new features, improving documentation, or sharing feedback.

Table of Contents

How to Contribute

There are many ways you can help improve this project:

  • Submit bug reports and suggestions
  • Fix bugs or typos
  • Add new features or enhancements
  • Improve documentation
  • Review and comment on pull requests

Getting Started

  1. Fork the repository
    Click the "Fork" button at the top right of this page to create your own copy.

  2. Clone your fork

    git clone https://github.com/<your-username>/chatterbox-tts-api.git
cd chatterbox-tts-api

  3. Set up your environment

    • Make sure you have Python 3.8+ and Node.js installed.
    • Install dependencies: 
      pip install -r requirements.txt
npm install

  4. Create a new branch for your changes

    git checkout -b your-feature-name

  5. Make your changes and commit

    • Write clear, concise commit messages.
    • Follow the coding conventions (see below).

  6. Push your branch and open a Pull Request

    git push origin your-feature-name
    • Go to your fork on GitHub and open a Pull Request (PR) to the main branch of travisvn/chatterbox-tts-api.

Code Style Guidelines

  • Python:
    Follow PEP 8. Use type hints where possible.
  • TypeScript/JavaScript:
    Use Prettier and ESLint defaults.
  • Commits:
    Use clear, descriptive commit messages (e.g., fix: handle edge case in TTS API).

Pull Requests

  • Make sure your PR passes all tests and CI checks.
  • Link related issues in your PR description.
  • Add relevant documentation or usage examples if introducing new features.
  • Be responsive to feedback and code review comments.

Reporting Issues

  • Search existing issues before submitting a new one.
  • Provide as much information as possible (steps to reproduce, logs, environment info).
  • Use clear titles and descriptive explanations.

Feature Requests

  • Open a new issue and select the “Feature Request” template, if available.
  • Clearly describe the feature, its motivation, and possible use cases.

Community & Support

Clone this wiki locally