Add community files: LICENSE, CONTRIBUTING.md, issue/PR templates

This commit is contained in:
Mahmoud Chen
2026-04-16 02:46:24 +03:00
parent f191891a6d
commit 4ee7f98e7d
6 changed files with 183 additions and 0 deletions
+40
View File
@@ -0,0 +1,40 @@
---
name: Bug Report
about: Create a report to help us reproduce and fix the bug
title: "[BUG] "
labels: bug
assignees: ''
---
## Description
A clear and concise description of what the bug is.
## Steps to Reproduce
1. Go to '...'
2. Run '...'
3. See error
## Expected Behavior
What you expected to happen.
## Actual Behavior
What actually happened instead.
## Environment
- Python version:
- MT5 Terminal version:
- Operating System:
- Broker:
## Screenshots
If applicable, add screenshots to help explain your problem.
## Logs
Include any relevant log output:
```
paste logs here
```
## Additional Context
Add any other context about the problem here.
+20
View File
@@ -0,0 +1,20 @@
---
name: Feature Request
about: Suggest a new feature or improvement
title: "[FEATURE] "
labels: enhancement
assignees: ''
---
## Is your feature request related to a problem?
A clear and concise description of what the problem is.
## Describe the solution you'd like
A clear and concise description of what you want to happen.
## Describe alternatives you've considered
Any alternative solutions or features you've considered.
## Additional Context
Add any other context or screenshots about the feature request here.
@@ -0,0 +1,26 @@
---
name: New Instrument Request
about: Request support for a new trading instrument
title: "[INSTRUMENT] "
labels: instrument-request
assignees: ''
---
## Instrument Details
- **Symbol**:
- **Instrument Name**:
- **Asset Class**: (forex/crypto/indices/commodities/stocks)
## Broker Information
- **Broker**:
- **MT5 Symbol Name**: (exact name as it appears in MT5)
## Use Case
Describe how you plan to use this instrument with the trading system.
## Strategy Ideas
List any specific strategies you'd like to see for this instrument.
## Additional Context
Add any other relevant information (trading hours, typical volatility, etc.)
+27
View File
@@ -0,0 +1,27 @@
## Description
Briefly describe the changes made in this PR.
## Type of Change
- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Refactoring
## Testing
Describe the testing you performed:
- [ ] Unit tests added/updated
- [ ] Manual testing performed
- [ ] No testing needed (documentation-only change)
## Checklist
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
## Additional Context
Add any other context about the PR here (screenshots, related issues, etc.)
+49
View File
@@ -0,0 +1,49 @@
# Contributing to Trading System Pro
Thank you for your interest in contributing to Trading System Pro!
## How to Contribute
### Reporting Bugs
1. **Check existing issues** - Search the issue tracker to see if your bug has been reported
2. **Create a detailed issue** - Include:
- Clear title describing the problem
- Steps to reproduce the bug
- Expected vs actual behavior
- Your environment (Python version, MT5 terminal version, OS)
- Any relevant logs or screenshots
### Suggesting Features
1. Open an issue with the label `feature-request`
2. Describe the feature you'd like to see
3. Explain why this feature would be valuable
4. Include any relevant research or references
### Pull Requests
1. **Fork the repository**
2. **Create a feature branch**: `git checkout -b feature/your-feature`
3. **Make your changes** following the existing code style
4. **Add tests** if applicable
5. **Update documentation** if your change affects the API or usage
6. **Submit a PR** with a clear description of what you fixed or added
## Code Style
- Use type hints where possible
- Follow PEP 8 guidelines
- Add docstrings to new functions and classes
- Keep lines under 100 characters when practical
## Testing
Run tests before submitting a PR:
```bash
python -m pytest tests/
```
## Questions?
Open an issue with the `question` label if you need help or have questions about contributing.
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 Trading System Pro
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.