Skip to content

Latest commit

 

History

History
70 lines (41 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

70 lines (41 loc) · 2.58 KB
Raw

Contributing to VoiceBox

Thank you for considering contributing to VoiceBox! We appreciate your time and effort to help make this project better.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

How to Contribute

We welcome contributions in various forms, including bug reports, feature requests, code contributions, documentation improvements, and more. To get started, follow these steps:

1. Reporting Bugs

If you encounter a bug, please open an issue on our issue tracker and provide detailed information about the problem, including steps to reproduce it. Make sure to check if the issue already exists before creating a new one.

2. Feature Requests

If you have an idea for a new feature or improvement, you can submit it as an issue on our issue tracker. Please include a clear description of the feature, its use case, and any relevant details.

3. Pull Requests

We encourage you to contribute code to VoiceBox. To submit a pull request, follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone your fork to your local machine.

    git clone https://github.com/tecnosam/voicebox.git

  3. Create a new branch for your changes.

    git checkout -b feature-name

  4. Make your changes and commit them.

    git add .
git commit -m "Description of your changes"

  5. Push your branch to your GitHub repository.

    git push origin feature-name

  6. Open a pull request on the main repository and provide a detailed description of your changes.

4. Coding Standards

Please adhere to the coding standards outlined in our .pylintrc file. Run linting checks locally before submitting your pull request.

pylint .

5. Code Reviews

All contributions, including pull requests and issues, will undergo code reviews. Be open to feedback and work collaboratively to address any suggestions.

Code of Conduct Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer, Samuel Ikaba, directly at [[email protected]]. The project maintainer will review and investigate all complaints and will respond in a way that it deems appropriate to the circumstances.

We aim to maintain a welcoming and inclusive community. Thank you for your cooperation!