Skip to content

Commit 1394570

Browse files
VoxHashVoxHash
committed
chore: repository cleanup, CI/CD setup, and release v3.1.0
- Remove temporary documentation files (GITHUB_TOPICS.md, summary files) - Update .gitignore with comprehensive patterns - Set up CI/CD workflows (CI, release, PyPI publishing) - Update core documentation (README, CHANGELOG, CONTRIBUTING, etc.) - Create release v3.1.0 tag - Add release process documentation - Move setup guides to docs/ directory
1 parent 0619117 commit 1394570

205 files changed

Lines changed: 47067 additions & 47545 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
1-
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
title: '[BUG] '
5-
labels: bug
6-
assignees: ''
7-
8-
---
9-
10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
12-
13-
**To Reproduce**
14-
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
19-
20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
22-
23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
25-
26-
**Environment:**
27-
- OS: [e.g. Windows 10, macOS 12, Ubuntu 20.04]
28-
- Python Version: [e.g. 3.10.0]
29-
- App Version: [e.g. 3.0.0]
30-
- PyQt6 Version: [e.g. 6.7.0]
31-
32-
**Additional context**
33-
Add any other context about the problem here.
34-
35-
**Logs**
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Environment:**
27+
- OS: [e.g. Windows 10, macOS 12, Ubuntu 20.04]
28+
- Python Version: [e.g. 3.10.0]
29+
- App Version: [e.g. 3.0.0]
30+
- PyQt6 Version: [e.g. 6.7.0]
31+
32+
**Additional context**
33+
Add any other context about the problem here.
34+
35+
**Logs**
3636
If applicable, add relevant log entries or error messages.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
---
2-
name: Feature request
3-
about: Suggest an idea for this project
4-
title: '[FEATURE] '
5-
labels: enhancement
6-
assignees: ''
7-
8-
---
9-
10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12-
13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
15-
16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
18-
19-
**Use case**
20-
Describe the use case and how this feature would be beneficial.
21-
22-
**Additional context**
23-
Add any other context or screenshots about the feature request here.
24-
25-
**Implementation complexity**
26-
- [ ] Low (simple change)
27-
- [ ] Medium (moderate complexity)
28-
- [ ] High (complex implementation)
29-
30-
**Priority**
31-
- [ ] Low
32-
- [ ] Medium
33-
- [ ] High
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Use case**
20+
Describe the use case and how this feature would be beneficial.
21+
22+
**Additional context**
23+
Add any other context or screenshots about the feature request here.
24+
25+
**Implementation complexity**
26+
- [ ] Low (simple change)
27+
- [ ] Medium (moderate complexity)
28+
- [ ] High (complex implementation)
29+
30+
**Priority**
31+
- [ ] Low
32+
- [ ] Medium
33+
- [ ] High
3434
- [ ] Critical

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
---
2-
name: Question
3-
about: Ask a question about the project
4-
title: '[QUESTION] '
5-
labels: question
6-
assignees: ''
7-
8-
---
9-
10-
**What is your question?**
11-
A clear and concise description of what you want to know.
12-
13-
**Context**
14-
Provide any relevant context about your question.
15-
16-
**What have you tried?**
17-
Describe what you've already tried to find the answer.
18-
19-
**Additional context**
20-
Add any other context or screenshots about the question here.
21-
22-
**Category**
23-
- [ ] Installation
24-
- [ ] Configuration
25-
- [ ] Usage
26-
- [ ] Development
27-
- [ ] Documentation
1+
---
2+
name: Question
3+
about: Ask a question about the project
4+
title: '[QUESTION] '
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
**What is your question?**
11+
A clear and concise description of what you want to know.
12+
13+
**Context**
14+
Provide any relevant context about your question.
15+
16+
**What have you tried?**
17+
Describe what you've already tried to find the answer.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the question here.
21+
22+
**Category**
23+
- [ ] Installation
24+
- [ ] Configuration
25+
- [ ] Usage
26+
- [ ] Development
27+
- [ ] Documentation
2828
- [ ] Other

‎.github/pull_request_template.md‎

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,53 @@
1-
# Pull Request
2-
3-
## Description
4-
Brief description of what this PR does.
5-
6-
## Type of Change
7-
- [ ] Bug fix (non-breaking change which fixes an issue)
8-
- [ ] New feature (non-breaking change which adds functionality)
9-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10-
- [ ] Documentation update
11-
- [ ] Code refactoring
12-
- [ ] Performance improvement
13-
- [ ] Test addition/update
14-
15-
## Related Issues
16-
Closes #(issue number)
17-
18-
## Changes Made
19-
- [ ] List the main changes made
20-
- [ ] Include any new features
21-
- [ ] Mention any bug fixes
22-
- [ ] Note any breaking changes
23-
24-
## Testing
25-
- [ ] Unit tests pass
26-
- [ ] Integration tests pass
27-
- [ ] Manual testing completed
28-
- [ ] Performance testing completed (if applicable)
29-
30-
## Screenshots (if applicable)
31-
Add screenshots to help explain your changes.
32-
33-
## Checklist
34-
- [ ] My code follows the project's style guidelines
35-
- [ ] I have performed a self-review of my own code
36-
- [ ] I have commented my code, particularly in hard-to-understand areas
37-
- [ ] I have made corresponding changes to the documentation
38-
- [ ] My changes generate no new warnings
39-
- [ ] I have added tests that prove my fix is effective or that my feature works
40-
- [ ] New and existing unit tests pass locally with my changes
41-
- [ ] Any dependent changes have been merged and published
42-
43-
## Additional Notes
44-
Add any additional notes about the PR here.
45-
46-
## Breaking Changes
47-
If this PR contains breaking changes, describe them here and provide migration instructions.
48-
49-
## Performance Impact
50-
If this PR affects performance, describe the impact and any optimizations made.
51-
52-
## Security Considerations
1+
# Pull Request
2+
3+
## Description
4+
Brief description of what this PR does.
5+
6+
## Type of Change
7+
- [ ] Bug fix (non-breaking change which fixes an issue)
8+
- [ ] New feature (non-breaking change which adds functionality)
9+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] Documentation update
11+
- [ ] Code refactoring
12+
- [ ] Performance improvement
13+
- [ ] Test addition/update
14+
15+
## Related Issues
16+
Closes #(issue number)
17+
18+
## Changes Made
19+
- [ ] List the main changes made
20+
- [ ] Include any new features
21+
- [ ] Mention any bug fixes
22+
- [ ] Note any breaking changes
23+
24+
## Testing
25+
- [ ] Unit tests pass
26+
- [ ] Integration tests pass
27+
- [ ] Manual testing completed
28+
- [ ] Performance testing completed (if applicable)
29+
30+
## Screenshots (if applicable)
31+
Add screenshots to help explain your changes.
32+
33+
## Checklist
34+
- [ ] My code follows the project's style guidelines
35+
- [ ] I have performed a self-review of my own code
36+
- [ ] I have commented my code, particularly in hard-to-understand areas
37+
- [ ] I have made corresponding changes to the documentation
38+
- [ ] My changes generate no new warnings
39+
- [ ] I have added tests that prove my fix is effective or that my feature works
40+
- [ ] New and existing unit tests pass locally with my changes
41+
- [ ] Any dependent changes have been merged and published
42+
43+
## Additional Notes
44+
Add any additional notes about the PR here.
45+
46+
## Breaking Changes
47+
If this PR contains breaking changes, describe them here and provide migration instructions.
48+
49+
## Performance Impact
50+
If this PR affects performance, describe the impact and any optimizations made.
51+
52+
## Security Considerations
5353
If this PR affects security, describe the security implications and any measures taken.

‎.github/test_config.json‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
{
2-
"symbol": "EURUSD=X",
3-
"start_date": "2023-01-01",
4-
"end_date": "2023-12-31",
5-
"initial_balance": 10000.0,
6-
"min_sharpe": 0.3,
7-
"max_drawdown": 0.5,
8-
"min_trades": 5,
9-
"min_win_rate": 0.3
10-
}
11-
1+
{
2+
"symbol": "EURUSD=X",
3+
"start_date": "2023-01-01",
4+
"end_date": "2023-12-31",
5+
"initial_balance": 10000.0,
6+
"min_sharpe": 0.3,
7+
"max_drawdown": 0.5,
8+
"min_trades": 5,
9+
"min_win_rate": 0.3
10+
}
11+

0 commit comments

Comments
 (0)