Thank you for considering contributing to our project! We appreciate your efforts to make the Speech Dataset Generator better.
-
Fork the Repository: Fork the repository to your GitHub account.
-
Clone the Repository: Clone the forked repository to your local machine:
git clone https://github.com/your-username/speech-dataset-generator.git
-
Create a New Branch: Create a new branch for your changes:
git checkout -b feature/your-feature
-
Make Changes: Make your changes and ensure that the code follows our coding standards.
-
Test Thoroughly: Test your changes thoroughly.
-
Commit Changes: Commit your changes with a descriptive commit message:
git commit -m "Add your descriptive message here"
-
Push Changes: Push your changes to your forked repository:
git push origin feature/your-feature
-
Open a Pull Request: Open a pull request on our
main
branch. Provide a clear title and description, including any relevant information.
- Follow Coding Style: Follow the coding style used in the project.
- Write Clear Code: Write clear and concise code.
- Comments: Add comments when necessary to explain complex logic or functionality.
- Include Tests: Include tests for your changes.
- Ensure Passing Tests: Ensure that existing tests pass.
If you find any issues or bugs, please open a GitHub issue with a clear description and, if possible, steps to reproduce the problem.
-
Substantial Changes: Ensure that your pull requests involve substantial changes that contribute meaningfully to the project. Pull requests with minor or trivial changes (e.g., single-letter modifications) may not be accepted.
-
Quality Contributions: Prioritize quality over quantity. Pull requests should improve the project, fix a bug, or add a valuable feature. Contributions solely aimed at gaining collaborator status without substantial improvements will be reviewed critically.
Please adhere to our Code of Conduct in all interactions and contributions.
By contributing, you agree that your contributions will be licensed under the project's license.