Skip to content

Commit f2de83c

Browse files
committed
save
1 parent 929e135 commit f2de83c

File tree

4 files changed

+55
-2
lines changed

4 files changed

+55
-2
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2021 Joao Euko
3+
Copyright (c) 2021-2025 Joao Euko
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

docs/contributing.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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

docs/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,13 @@
1010
# MQPy
1111

1212
MQPy is a Python library designed to simplify the process of creating Expert Advisors for MetaTrader 5. While developing directly in MQL5 can be complex, MQPy provides a more streamlined experience using Python.
13+
14+
## Need Help or Found an Issue?
15+
16+
If you need help or have found an issue, you can:
17+
18+
- [Report a bug 🐛](https://github.com/Joaopeuko/Mql5-Python-Integration/issues/new?template=fix.yaml&title=fix%3A+)
19+
- [Request documentation improvements 📚](https://github.com/Joaopeuko/Mql5-Python-Integration/issues/new?template=docs.yaml&title=docs%3A+)
20+
- [Suggest a new feature ✨](https://github.com/Joaopeuko/Mql5-Python-Integration/issues/new?template=feat.yaml&title=feat%3A+)
21+
22+
See the [Contributing](contributing.md) page for all available issue templates and more ways to contribute.

mkdocs.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,4 +146,5 @@ plugins:
146146
- mkdocs-jupyter
147147
nav:
148148
- Home: index.md
149-
- API Reference: reference/
149+
- Contributing: contributing.md
150+
- Code documentation: reference/

0 commit comments

Comments
 (0)