|
| 1 | +# Contributing to MQPy |
| 2 | + |
| 3 | +Thank you for your interest in contributing to MQPy! There are many ways to contribute, and we appreciate all of them. |
| 4 | + |
| 5 | +## Development Process |
| 6 | + |
| 7 | +1. Fork the repository |
| 8 | +2. Create a feature branch |
| 9 | +3. Make your changes |
| 10 | +4. Submit a pull request |
| 11 | + |
| 12 | +## Reporting Issues |
| 13 | + |
| 14 | +If you've found a bug or have a feature request, please file an issue using one of our issue templates: |
| 15 | + |
| 16 | +### Issue Templates |
| 17 | + |
| 18 | +Choose the appropriate template for your issue: |
| 19 | + |
| 20 | +- **Bug Fix**: [Report a bug 🐛](https://github.com/Joaopeuko/Mql5-Python-Integration/issues/new?template=fix.yaml&title=fix%3A+) |
| 21 | +- **Documentation**: [Request documentation improvements 📚](https://github.com/Joaopeuko/Mql5-Python-Integration/issues/new?template=docs.yaml&title=docs%3A+) |
| 22 | +- **Feature Request**: [Suggest a new feature ✨](https://github.com/Joaopeuko/Mql5-Python-Integration/issues/new?template=feat.yaml&title=feat%3A+) |
| 23 | +- **Performance Improvement**: [Report performance issues ⚡](https://github.com/Joaopeuko/Mql5-Python-Integration/issues/new?template=perf.yaml&title=perf%3A+) |
| 24 | +- **Test**: [Suggest test improvements 🧪](https://github.com/Joaopeuko/Mql5-Python-Integration/issues/new?template=test.yaml&title=test%3A+) |
| 25 | +- **Build**: [Report build issues 🔨](https://github.com/Joaopeuko/Mql5-Python-Integration/issues/new?template=build.yaml&title=build%3A+) |
| 26 | +- **Chore**: [Suggest maintenance tasks 🧹](https://github.com/Joaopeuko/Mql5-Python-Integration/issues/new?template=chore.yaml&title=chore%3A+) |
| 27 | +- **Style**: [Report style issues 💅](https://github.com/Joaopeuko/Mql5-Python-Integration/issues/new?template=style.yaml&title=style%3A+) |
| 28 | +- **Refactor**: [Suggest code refactoring 🔄](https://github.com/Joaopeuko/Mql5-Python-Integration/issues/new?template=refactor.yaml&title=refactor%3A+) |
| 29 | +- **CI**: [Suggest CI improvements ⚙️](https://github.com/Joaopeuko/Mql5-Python-Integration/issues/new?template=ci.yaml&title=ci%3A+) |
| 30 | + |
| 31 | +## Coding Standards |
| 32 | + |
| 33 | +- Follow PEP 8 style guide |
| 34 | +- Write docstrings in Google format |
| 35 | +- Include appropriate tests |
| 36 | + |
| 37 | +## Pull Request Process |
| 38 | + |
| 39 | +1. Ensure your code meets all tests |
| 40 | +2. Update documentation where necessary |
| 41 | +3. The PR should work for Python 3.6 and above |
| 42 | +4. PRs will be merged once reviewed by maintainers |
0 commit comments