Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.12 KB

File metadata and controls

50 lines (33 loc) · 1.12 KB

Contributing to ShapeVoice

Thank you for your interest in contributing to ShapeVoice.

ShapeVoice is an experimental text-to-sound synthesis engine that converts text into audio using waveform generation.

Getting Started

  1. Fork the repository.
  2. Clone your fork.
  3. Install the required dependencies.
  4. Create a new branch for your changes.

Types of Contributions

Contributions may include:

  • Bug fixes
  • Performance improvements
  • Documentation improvements
  • New waveform generators
  • Audio quality improvements
  • Code cleanup and refactoring

Code Style

  • Keep code readable and well-commented.
  • Use descriptive variable names.
  • Follow existing project structure where possible.

Pull Requests

When creating a pull request:

  • Clearly explain the changes.
  • Test your changes before submitting.
  • Keep pull requests focused on a specific improvement.

Reporting Issues

When reporting an issue, include:

  • Operating system
  • Python version
  • Error messages
  • Steps to reproduce the problem

Notes

ShapeVoice is an experimental project. Not all suggestions may be implemented, but feedback is always appreciated.