🤝 How to Contribute
We welcome contributions from the community! Whether you're fixing a bug, adding a feature, or improving documentation, your help is greatly appreciated.
Please take a moment to read through these guidelines before submitting a pull request or issue.
🧩 Contribution Types We Accept
- Bug fixes
- New features (must align with project roadmap)
- Documentation improvements
- Code refactoring and optimization
- Testing improvements (unit tests, integration tests)
- Example use cases or tutorials
📌 Forking the Repository
- Fork the repository
📌 Submitting a Pull Request (PR)
- Fork the repository from GitHub
- Clone the repository to your local machine
git clone https://github.com/your-username/your-repo.git
- Create a new branch :
git checkout -b feature/your-feature-name
- Make your changes
- Test your changes thoroughly
- Commit your changes with a clear and descriptive message:
git commit -m "Fix bug in chatbot response handling"
- Push to your fork
git push origin feature/your-feature-name
- Open a PR on the original repository
- Wait for review and feedback
- Please follow the README.md instructions for run and commit the changes.
📌 Code Style and Formatting
- Follow the existing code style and formatting
- Use meaningful variable and function names
- Add comments to explain complex code
- Keep code clean and readable
📚 Documentation Guidelines
If you're updating or writing documentation:
- Use clear and concise language
- Keep examples simple but practical
- Ensure all code examples are working and up-to-date
🐛 Reporting Bugs / Suggesting Features
Use the GitHub Issues section to report bugs or suggest enhancements.
When reporting a bug, please include:
A clear title and description Steps to reproduce Expected behavior vs actual behavior Environment info (OS, Python version, etc.) For feature requests, please describe:
The problem you're trying to solve How the feature would improve the project Any alternative solutions considered 📚 Documentation Guidelines If you're updating or writing documentation:
Use clear and concise language Keep examples simple but practical Ensure all code examples are working and up-to-date 🔐 Licensing By contributing to this project, you agree that your contributions will be licensed under the Apache 2.0 License .
All contributions must be your own original work or clearly indicate if derived from another source.
🧑⚖️ Code of Conduct We expect all contributors to follow our Code of Conduct . Please treat others with respect and keep the environment welcoming and inclusive.
🙌 Thank You! Your contribution helps make this project better for everyone. We appreciate your time and effort.