Welcome to DocIndex! We appreciate your interest in contributing to our open-source project. Please take a moment to review the following guidelines to ensure a smooth and collaborative experience for everyone.
Before contributing, please read and adhere to our Code of Conduct. We are committed to fostering an inclusive and respectful community.
If you encounter a bug or issue with the project, please search the issue tracker to see if it has already been reported. If not, please open a new issue with a clear and descriptive title, along with detailed steps to reproduce the issue.
We welcome suggestions for enhancements or new features. Please open a new issue with a clear description of the enhancement or feature you'd like to see, along with any relevant context or use cases.
We appreciate contributions via pull requests. Before submitting a pull request, please ensure that:
- You have added appropriate tests (if applicable)
- Your pull request addresses a specific issue or feature request
Please reference the relevant issue or feature request in your pull request description.
To get started with contributing to African Whisper, follow these steps:
- Fork the repository and clone it to your local machine.
- Install dependencies by running
pip install -r requirements.txt(or equivalent). - Create a new branch for your changes:
git checkout -b my-feature-branch. - Make your changes and commit them:
git commit -am 'Add new feature'. - Push your changes to your fork:
git push origin my-feature-branch. - Submit a pull request to the repository's
masterbranch.
By contributing to DocIndex, you agree to license your contributions under the project's license.
Thank you for your contributions!