Contributing to MQPy#
Thank you for your interest in contributing to MQPy! There are many ways to contribute, and we appreciate all of them.
Development Process#
- Fork the repository
- Create a feature branch
- Make your changes
- Submit a pull request
Reporting Issues#
If you've found a bug or have a feature request, please file an issue using one of our issue templates:
Issue Templates#
Choose the appropriate template for your issue:
- Bug Fix: Report a bug ๐
- Documentation: Request documentation improvements ๐
- Feature Request: Suggest a new feature โจ
- Performance Improvement: Report performance issues โก
- Test: Suggest test improvements ๐งช
- Build: Report build issues ๐จ
- Chore: Suggest maintenance tasks ๐งน
- Style: Report style issues ๐
- Refactor: Suggest code refactoring ๐
- CI: Suggest CI improvements โ๏ธ
Coding Standards#
- Follow PEP 8 style guide
- Write docstrings in Google format
- Include appropriate tests
Pull Request Process#
- Ensure your code meets all tests
- Update documentation where necessary
- The PR should work for Python 3.6 and above
- PRs will be merged once reviewed by maintainers