Skip to content

Commit bee0a5e

Browse files
ctasadagithub-actions[bot]
ctasada
and
github-actions[bot]
authored
chore: Documentation improvements (#239)
* chore: Clean up README by removing outdated projects and bugs * chore: Update documentation and add issue templates * docs: Add AGENTS.md for AI agent guidance and project overview --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 5a50ac3 commit bee0a5e

35 files changed

+7726
-2231
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or issue with Stonks Overwatch
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
A clear and concise description of what the bug is.
12+
13+
## Steps to Reproduce
14+
15+
1. Go to '...'
16+
2. Click on '...'
17+
3. Scroll down to '...'
18+
4. See error
19+
20+
## Expected Behavior
21+
22+
A clear and concise description of what you expected to happen.
23+
24+
## Actual Behavior
25+
26+
A clear and concise description of what actually happened.
27+
28+
## Screenshots
29+
30+
If applicable, add screenshots to help explain your problem.
31+
32+
## Environment
33+
34+
- **OS**: [e.g., macOS 14.0, Windows 11, Ubuntu 22.04]
35+
- **Python Version**: [e.g., 3.13.0]
36+
- **Stonks Overwatch Version**: [e.g., 0.1.5]
37+
- **Browser** (if web UI): [e.g., Chrome 120, Firefox 121]
38+
39+
## Configuration
40+
41+
**Which brokers are you using?**
42+
- [ ] DEGIRO
43+
- [ ] Bitvavo
44+
- [ ] IBKR
45+
46+
**Are you using:**
47+
- [ ] Web application (`make run`)
48+
- [ ] Native application
49+
- [ ] Docker
50+
51+
## Logs
52+
53+
Please attach relevant log entries from `data/logs/stonks-overwatch.log`
54+
55+
<details>
56+
<summary>Log output</summary>
57+
58+
```
59+
Paste relevant log entries here
60+
```
61+
62+
</details>
63+
64+
## Additional Context
65+
66+
Add any other context about the problem here.
67+
68+
## Checklist
69+
70+
- [ ] I have searched for existing issues
71+
- [ ] I have read the [FAQ](../docs/FAQ.md)
72+
- [ ] I have checked the [documentation](../docs/Home.md)
73+
- [ ] I am using the latest version
74+
- [ ] I have included relevant log entries

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 💬 GitHub Discussions
4+
url: https://github.com/ctasada/stonks-overwatch/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: 📚 Documentation
7+
url: https://github.com/ctasada/stonks-overwatch/blob/main/docs/Home.md
8+
about: Read the complete documentation
9+
- name: ❓ FAQ
10+
url: https://github.com/ctasada/stonks-overwatch/blob/main/docs/FAQ.md
11+
about: Check frequently asked questions

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement for Stonks Overwatch
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
11+
A clear and concise description of the feature you'd like to see.
12+
13+
## Problem Statement
14+
15+
What problem does this feature solve? Why would this be useful?
16+
17+
**Example:** "I'm frustrated when I try to [...]"
18+
19+
## Proposed Solution
20+
21+
Describe how you envision this feature working.
22+
23+
## Alternative Solutions
24+
25+
Have you considered any alternative approaches? Describe them here.
26+
27+
## Use Cases
28+
29+
Who would benefit from this feature? How would they use it?
30+
31+
1. User type: [e.g., active trader, long-term investor, developer]
32+
2. Scenario: [e.g., monitoring daily performance, tracking dividends]
33+
34+
## Related Features
35+
36+
Are there existing features this relates to or builds upon?
37+
38+
- Related to: #[issue number]
39+
- Depends on: #[issue number]
40+
41+
## Implementation Ideas
42+
43+
If you have thoughts on how this could be implemented, share them here.
44+
45+
## Mockups/Examples
46+
47+
If applicable, add mockups, wireframes, or examples from other applications.
48+
49+
## Broker-Specific
50+
51+
Is this feature specific to a particular broker?
52+
53+
- [ ] DEGIRO
54+
- [ ] Bitvavo
55+
- [ ] IBKR
56+
- [ ] All brokers
57+
- [ ] Core application
58+
59+
## Priority
60+
61+
How important is this feature to you?
62+
63+
- [ ] Critical - Blocking my usage
64+
- [ ] High - Would significantly improve my experience
65+
- [ ] Medium - Nice to have
66+
- [ ] Low - Just an idea
67+
68+
## Additional Context
69+
70+
Add any other context, screenshots, or information about the feature request here.
71+
72+
## Checklist
73+
74+
- [ ] I have searched for existing feature requests
75+
- [ ] I have read the [documentation](../docs/Home.md)
76+
- [ ] I have checked the [CHANGELOG](../CHANGELOG.md) to see if this is already planned
77+
- [ ] This is a single, focused feature request (not multiple features)

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Question
3+
about: Ask a question about Stonks Overwatch
4+
title: '[QUESTION] '
5+
labels: question
6+
assignees: ''
7+
---
8+
9+
## Question
10+
11+
What would you like to know?
12+
13+
## Context
14+
15+
Provide any relevant context or background for your question.
16+
17+
## What I've Tried
18+
19+
Have you already tried finding the answer? Where did you look?
20+
21+
- [ ] Read the [FAQ](../docs/FAQ.md)
22+
- [ ] Searched the [documentation](../docs/Home.md)
23+
- [ ] Searched existing issues
24+
- [ ] Checked broker-specific docs ([DEGIRO](../docs/DEGIRO.md), [Bitvavo](../docs/Bitvavo.md), [IBKR](../docs/IBKR.md))
25+
26+
## Environment (if relevant)
27+
28+
- **OS**: [e.g., macOS, Windows, Linux]
29+
- **Python Version**: [e.g., 3.13.0]
30+
- **Stonks Overwatch Version**: [e.g., 0.1.5]
31+
32+
## Additional Context
33+
34+
Any other information that might be helpful in answering your question.
35+
36+
---
37+
38+
💡 **Tip:** For general questions and discussions, consider using [GitHub Discussions](https://github.com/ctasada/stonks-overwatch/discussions) instead of opening an issue.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
<!-- Provide a brief description of your changes -->
6+
7+
## Type of Change
8+
9+
<!-- Mark the relevant option with an 'x' -->
10+
11+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
12+
- [ ] ✨ New feature (non-breaking change which adds functionality)
13+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] 📝 Documentation update
15+
- [ ] 🔧 Code refactoring (no functional changes)
16+
- [ ] ✅ Test additions or modifications
17+
- [ ] 🏦 New broker integration
18+
- [ ] 🎨 UI/UX improvements
19+
20+
## Related Issues
21+
22+
<!-- Link related issues using keywords: Fixes #123, Closes #456, Relates to #789 -->
23+
24+
- Fixes #
25+
- Relates to #
26+
27+
## Changes Made
28+
29+
<!-- List the main changes in your PR -->
30+
31+
-
32+
-
33+
-
34+
35+
## Testing
36+
37+
### Testing Performed
38+
39+
<!-- Describe the tests you ran to verify your changes -->
40+
41+
- [ ] All existing tests pass (`make test`)
42+
- [ ] Added new tests for new functionality
43+
- [ ] Manual testing completed
44+
- [ ] Tested with demo data (`make run demo=true`)
45+
- [ ] Tested with real broker connection
46+
47+
### Test Configuration
48+
49+
<!-- If applicable, describe your test setup -->
50+
51+
- **Brokers tested**: [e.g., DEGIRO, Bitvavo, IBKR]
52+
- **Environment**: [e.g., macOS, Docker, native app]
53+
- **Python version**: [e.g., 3.13.0]
54+
55+
## Code Quality
56+
57+
- [ ] Code follows project style guidelines (`make lint-check` passes)
58+
- [ ] Code has been formatted (`make lint-fix`)
59+
- [ ] Added/updated docstrings for new code
60+
- [ ] Added/updated type hints
61+
- [ ] No commented-out code or debug statements
62+
63+
## Documentation
64+
65+
- [ ] Updated relevant documentation
66+
- [ ] Added/updated code comments where necessary
67+
- [ ] Updated CHANGELOG.md (if applicable)
68+
- [ ] Added docstrings to new functions/classes
69+
70+
## Screenshots (if applicable)
71+
72+
<!-- Add screenshots for UI changes -->
73+
74+
**Before:**
75+
<!-- Screenshot of old behavior -->
76+
77+
**After:**
78+
<!-- Screenshot of new behavior -->
79+
80+
## Breaking Changes
81+
82+
<!-- If this PR includes breaking changes, describe them here and provide migration instructions -->
83+
84+
- [ ] No breaking changes
85+
- [ ] Breaking changes documented below
86+
87+
**Breaking changes:**
88+
<!-- Describe any breaking changes -->
89+
90+
**Migration guide:**
91+
<!-- Provide instructions for migrating from the old behavior to the new -->
92+
93+
## Deployment Notes
94+
95+
<!-- Any special deployment considerations or steps needed -->
96+
97+
- [ ] No special deployment steps
98+
- [ ] Requires database migration
99+
- [ ] Requires configuration updates
100+
- [ ] Requires dependency updates
101+
102+
## Checklist
103+
104+
<!-- Mark all that apply -->
105+
106+
- [ ] I have read the [CONTRIBUTING](../docs/CONTRIBUTING.md) guidelines
107+
- [ ] My code follows the project's code style
108+
- [ ] I have performed a self-review of my code
109+
- [ ] I have commented my code, particularly in hard-to-understand areas
110+
- [ ] I have made corresponding changes to the documentation
111+
- [ ] My changes generate no new warnings or errors
112+
- [ ] I have added tests that prove my fix is effective or that my feature works
113+
- [ ] New and existing unit tests pass locally with my changes
114+
- [ ] Any dependent changes have been merged and published
115+
116+
## Additional Context
117+
118+
<!-- Add any other context about the pull request here -->
119+
120+
---
121+
122+
**Thank you for contributing to Stonks Overwatch!** 🎉

0 commit comments

Comments
 (0)