Skip to content

FinceptTerminal is a modern finance application offering advanced market analytics, investment research, and economic data tools, designed for interactive exploration and data-driven decision-making in a user-friendly environment.

chore: refactor GitHub templates for fincept-qt C++/Qt6 terminal

tilakpatel22ea53d89e4855
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 54ec1fd07..0c9cfa07a 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,69 +1,43 @@
-# Contribute to Fincept Terminal
+# Contributing to Fincept Terminal
-Want to make Fincept Terminal even better? We'd love your help!
+Fincept Terminal is a native C++20/Qt6 desktop financial terminal. All contributions are welcome!
-## Where We Need You
+## Ways to Contribute
-**C++ Development**
- - Build new screens and features using Qt6 Widgets
- - Improve core infrastructure, performance, and stability
+- **C++ / Qt6** — new screens, performance fixes, core infrastructure
+- **Python Analytics** — data scripts, AI agents, quant modules
+- **Data Sources** — connect APIs, brokers, government financial databases
+- **Bug Reports & Feature Requests** — open an issue
-**Data Source Integration**
- - Connect government financial databases (e.g., data.gov.in, data.gov)
- - Write Python data fetcher scripts for new APIs
+## Getting Started
-**Analytics & AI**
- - Build Python analytics modules (portfolio, derivatives, risk)
- - Implement new AI agent frameworks
+```bash
+# Fork & clone
+git clone https://github.com/your-username/FinceptTerminal.git
+cd FinceptTerminal/fincept-qt
-**Brokerage API Integration**
- - Connect stock brokers so users can trade directly from the terminal
- - Work on country-specific broker adapters in C++
+# Build — Linux/macOS
+cmake -B build -DCMAKE_BUILD_TYPE=Release && cmake --build build --parallel
-**Documentation**
- - Create and maintain comprehensive documentation
- - Cover build setup, architecture, and developer guides
+# Build — Windows (VS 2022 Developer Command Prompt)
+cmake -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="C:/Qt/6.x.x/msvc2022_64"
+cmake --build build --config Release
----
+# Create a branch
+git checkout -b feature/your-feature
+```
-## How to Get Started
+## Code Guidelines
-1. **Fork** this repo & clone it:
- ```bash
- git clone https://github.com/your-username/FinceptTerminal.git
- ```
+- C++20, `snake_case` for functions/variables, `PascalCase` for types
+- Screens render UI only — no business logic or direct HTTP calls
+- Never block the UI thread (`waitForFinished()` forbidden on main thread)
+- Use `Result<T>` for error handling, `LOG_INFO`/`LOG_ERROR` for logging
-2. **Build** the project:
- ```bash
- cd FinceptTerminal/fincept-qt
+## Submitting a PR
- # Linux / macOS
- cmake -B build -DCMAKE_BUILD_TYPE=Release
- cmake --build build --parallel
+1. Push your branch and open a Pull Request against `main`
+2. Link any related issues
+3. Keep changes focused — one feature or fix per PR
- # Windows (Developer Command Prompt for VS 2022)
- cmake -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="C:/Qt/6.x.x/msvc2022_64"
- cmake --build build --config Release --parallel
- ```
-
-3. **Create a new branch** for your feature:
- ```bash
- git checkout -b feature/awesome-feature
- ```
-
-4. **Code**, follow the [C++ Contributing Guide](../fincept-qt/CONTRIBUTING.md) or [Python Guide](../docs/PYTHON_CONTRIBUTOR_GUIDE.md), and document your changes.
-
-5. **Push your changes** and open a **pull request**:
- ```bash
- git push origin feature/awesome-feature
- ```
-
----
-
-## Guidelines
-
-- **Bug Reports:** [File an issue](https://github.com/Fincept-Corporation/FinceptTerminal/issues/new)
-- **Feature Requests:** Open a [GitHub Discussion](https://github.com/Fincept-Corporation/FinceptTerminal/discussions)
-- **Code Contributions:** Keep it clean & simple. Well-documented code is appreciated.
-
-**Join the movement!** Let's build the future of finance together. Questions? Ping us at [[email protected]](mailto:[email protected]).
+Questions? [[email protected]](mailto:[email protected]) · [Discord](https://discord.gg/ae87a8ygbN)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 8454740c2..d218d5501 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,5 +1,5 @@
---
-name: 🐛 Bug Report
+name: Bug Report
about: Report a bug or unexpected behavior in Fincept Terminal
title: "[BUG] "
labels: "type:bug, status:triage"
@@ -7,19 +7,23 @@ assignees: ""
---
## What happened?
-<!-- Describe the bug and what you expected to happen -->
+<!-- Describe the bug and what you expected instead -->
-## How to reproduce?
-<!-- Steps to reproduce the issue -->
+## Steps to Reproduce
1.
2.
3.
## Environment
-- **OS:**
-- **Version:**
-- **Error logs (if any):**
+- **OS:** (Windows / macOS / Linux)
+- **Fincept Terminal Version:**
+- **Qt Version:**
+
+## Error Logs
+```
+Paste any error messages or crash logs here
```
-Paste error messages here
-```
\ No newline at end of file
+
+## Screenshots
+<!-- If applicable, add screenshots to help explain the issue -->
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
index 23859169b..d64704b34 100644
--- a/.github/ISSUE_TEMPLATE/documentation.md
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -1,18 +1,18 @@
---
-name: 📚 Documentation Issue
+name: Documentation Issue
about: Report missing, unclear, or incorrect documentation
title: "[DOCS] "
labels: "type:documentation, status:triage"
assignees: ""
---
-## What's the documentation issue?
+## What's the issue?
<!-- Describe what's missing, unclear, or incorrect -->
-## Where is it located?
-<!-- File path, page URL, or section name -->
+## Where is it?
+<!-- File path, section name, or URL -->
-## What should it say instead?
-<!-- Your suggestion for improvement -->
+## Suggested fix
+<!-- What should it say instead? -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 485efc781..ff1c952a3 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,18 +1,18 @@
---
-name: 🌟 Feature Request
-about: Suggest a new feature or enhancement for Fincept Terminal
+name: Feature Request
+about: Suggest a new feature or screen for Fincept Terminal
title: "[FEATURE] "
labels: "type:feature, status:triage"
assignees: ""
---
## What feature would you like?
-<!-- Describe the feature you want to see -->
+<!-- Describe the feature clearly -->
-## What problem does this solve?
-<!-- Explain the use case and who would benefit -->
+## What problem does it solve?
+<!-- Who benefits from this and how? -->
-## Any alternatives or additional context?
-<!-- Optional: alternatives considered, examples, mockups, etc. -->
+## Additional context
+<!-- Mockups, examples, or alternatives considered -->
diff --git a/.github/ISSUE_TEMPLATE/improvement.md b/.github/ISSUE_TEMPLATE/improvement.md
index f1ae801a2..1497d11ef 100644
--- a/.github/ISSUE_TEMPLATE/improvement.md
+++ b/.github/ISSUE_TEMPLATE/improvement.md
@@ -1,18 +1,18 @@
---
-name: ✨ Improvement Suggestion
-about: Suggest enhancements or improvements to existing features in Fincept Terminal
+name: Improvement Suggestion
+about: Suggest an enhancement to an existing feature in Fincept Terminal
title: "[IMPROVE] "
labels: "type:enhancement, status:triage"
assignees: ""
---
-## What feature needs improvement?
-<!-- Identify the existing feature or area -->
+## Which feature needs improvement?
+<!-- Name the screen or feature (e.g., Dashboard, Crypto Trading, News) -->
## How should it be improved?
-<!-- Describe your suggested enhancement and why it's better -->
+<!-- Describe what change would make it better and why -->
-## Any additional context?
-<!-- Optional: mockups, examples, alternatives, etc. -->
+## Additional context
+<!-- Mockups, examples, or alternatives -->
diff --git a/.github/ISSUE_TEMPLATE/performance_issues.md b/.github/ISSUE_TEMPLATE/performance_issues.md
index b2d514301..71a9d3cdb 100644
--- a/.github/ISSUE_TEMPLATE/performance_issues.md
+++ b/.github/ISSUE_TEMPLATE/performance_issues.md
@@ -1,24 +1,25 @@
---
-name: ⚡ Performance Issue
-about: Report performance problems, slowness, or resource usage issues
+name: Performance Issue
+about: Report slowness, UI freezing, high memory/CPU usage, or startup delays
title: "[PERFORMANCE] "
labels: "type:performance, status:triage"
assignees: ""
---
-## What's slow?
-<!-- Describe the performance issue and when it occurs -->
+## What's slow or freezing?
+<!-- Describe the issue and when it happens (e.g., on startup, when switching screens) -->
-## How to reproduce?
-<!-- Steps to reproduce the slowness -->
+## Steps to Reproduce
1.
2.
3.
-## Environment & measurements
-- **OS:**
-- **Version:**
-- **Dataset/Operation size:**
-- **Time taken:**
-- **Expected time:**
\ No newline at end of file
+## Environment & Measurements
+- **OS:** (Windows / macOS / Linux)
+- **Fincept Terminal Version:**
+- **Observed behavior:** (e.g., UI froze for 5s, memory jumped to 2GB)
+- **Expected behavior:**
+
+## Additional context
+<!-- Task Manager screenshots, logs, or anything else helpful -->
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_for_terminal.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_for_terminal.md
index f3207c1dd..345d7dfa6 100644
--- a/.github/PULL_REQUEST_TEMPLATE/pull_request_for_terminal.md
+++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_for_terminal.md
@@ -1,230 +1,35 @@
-## 📝 Pull Request Summary
+## What does this PR do?
+<!-- Brief description of the change -->
-### Type of Change
-<!-- Please select the type of change this PR introduces -->
-- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
-- [ ] ✨ New feature (non-breaking change which adds functionality)
-- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] 🔄 Refactoring (code change that neither fixes a bug nor adds a feature)
-- [ ] 📚 Documentation update
-- [ ] 🧪 Test addition/improvement
-- [ ] ⚡ Performance improvement
-- [ ] 🔧 Configuration/build changes
-- [ ] 🎨 UI/UX improvements
-### Description
-<!-- Provide a clear and concise description of what this PR does -->
+## Type of Change
+- [ ] Bug fix
+- [ ] New feature / screen
+- [ ] Performance improvement
+- [ ] Refactoring
+- [ ] Documentation
+- [ ] Build / config change
+## Related Issues
+<!-- Fixes #, Closes #, or Related to # -->
-### Motivation and Context
-<!-- Why is this change required? What problem does it solve? -->
-<!-- If it fixes an open issue, please link to the issue here -->
+## Changes Made
+<!-- List key files/components changed and what was done -->
----
-## 🔗 Related Issues
-<!-- Link related issues using keywords to auto-close them when merged -->
-- Fixes #
-- Closes #
-- Addresses #
-- Related to #
+## How to Test
+1.
+2.
+3.
----
+## Checklist
+- [ ] Builds without errors on target platform
+- [ ] UI thread is never blocked (no `waitForFinished()` on main thread)
+- [ ] Timers start/stop in `showEvent()`/`hideEvent()`
+- [ ] No raw `QProcess` for Python — used `PythonRunner::instance().run()`
+- [ ] No sensitive data (API keys, credentials) committed
+- [ ] Tested manually on: (Windows / macOS / Linux)
-## 🔨 Technical Details
-
-### Changes Made
-<!-- List the specific technical changes made -->
-- [ ] **Core Logic Changes:**
-- [ ] **API Changes:**
-- [ ] **Database Changes:**
-- [ ] **UI/Frontend Changes:**
-- [ ] **Configuration Changes:**
-- [ ] **Dependencies Added/Updated:**
-- [ ] **Documentation Updates:**
-
-### Files Modified
-<!-- List key files that were modified -->
-- `file1.py` - Description of changes
-- `file2.js` - Description of changes
-- `config.yaml` - Description of changes
-
----
-
-## 🧪 Testing
-
-### Testing Strategy
-<!-- Describe how you tested these changes -->
-- [ ] Unit tests added/updated
-- [ ] Integration tests added/updated
-- [ ] Manual testing performed
-- [ ] End-to-end testing performed
-- [ ] Performance testing conducted
-- [ ] Cross-platform testing (if applicable)
-
-### Test Coverage
-<!-- If applicable, mention test coverage changes -->
-- Current coverage: _%
-- Coverage change: +/- _%
-
-### Testing Instructions
-<!-- Provide step-by-step instructions for reviewers to test -->
-1. Step 1
-2. Step 2
-3. Expected result:
-
----
-
-## 📊 Performance Impact
-
-### Performance Considerations
-<!-- Check all that apply -->
-- [ ] No performance impact expected
-- [ ] Performance improvement expected
-- [ ] Performance regression possible (explained below)
-- [ ] Performance testing required
-
-### Benchmarks
-<!-- If applicable, provide before/after performance metrics -->
-| Metric | Before | After | Change |
-|--------|--------|-------|--------|
-| Load time | - | - | - |
-| Memory usage | - | - | - |
-| CPU usage | - | - | - |
-
----
-
-## 🔄 Breaking Changes
-
-### Breaking Changes
-<!-- List any breaking changes and migration instructions -->
-- [ ] No breaking changes
-- [ ] Breaking changes present (detailed below)
-
-<!-- If breaking changes exist, provide details: -->
-**Migration Guide:**
-1. Step 1
-2. Step 2
-
-**Affected APIs/Features:**
-- API endpoint X changed from Y to Z
-- Configuration option A renamed to B
-
----
-
-## ✅ Pre-Submission Checklist
-
-### Code Quality
-- [ ] Code follows the project's style guidelines
-- [ ] Self-review of code completed
-- [ ] Code is well-commented, particularly in hard-to-understand areas
-- [ ] No debug statements or commented-out code left behind
-- [ ] Error handling is appropriate and consistent
-
-### Documentation
-- [ ] README updated (if needed)
-- [ ] API documentation updated (if needed)
-- [ ] Inline code documentation added/updated
-- [ ] CHANGELOG.md updated (if applicable)
-- [ ] Migration guide provided (for breaking changes)
-
-### Testing
-- [ ] All existing tests pass
-- [ ] New tests added for new functionality
-- [ ] Edge cases covered in tests
-- [ ] Manual testing completed
-- [ ] Cross-browser testing done (if frontend changes)
-
-### Dependencies & Security
-- [ ] No new security vulnerabilities introduced
-- [ ] Dependencies are up-to-date and necessary
-- [ ] No sensitive information exposed in code
-- [ ] License compatibility checked for new dependencies
-
-### Deployment & CI
-- [ ] CI/CD pipeline passes
-- [ ] Docker build succeeds (if applicable)
-- [ ] Database migrations work correctly (if applicable)
-- [ ] Environment variables documented (if new ones added)
-
----
-
-## 📷 Visual Changes
-<!-- Include screenshots/videos for UI changes -->
-
-### Before
-<!-- Screenshot/description of current state -->
-
-### After
-<!-- Screenshot/description of new state -->
-
----
-
-## 🤔 Review Focus Areas
-<!-- Guide reviewers on what to focus on -->
-Please pay special attention to:
-- [ ] Algorithm correctness in `function_name()`
-- [ ] Error handling in edge cases
-- [ ] Performance implications of the new feature
-- [ ] Security considerations for user input validation
-- [ ] Backward compatibility
-
----
-
-## 📚 Additional Context
-
-### Design Decisions
-<!-- Explain any significant design decisions made -->
-
-
-### Alternative Approaches
-<!-- Mention alternative approaches considered and why they were not chosen -->
-
-
-### Future Considerations
-<!-- Any follow-up work or future improvements planned -->
-
-
-### Dependencies
-<!-- List any dependencies this PR has on other PRs or external factors -->
-- Depends on PR #XXX
-- Requires deployment of service Y
-- Needs configuration update in environment Z
-
----
-
-## 🚀 Deployment Notes
-<!-- Any special instructions for deployment -->
-- [ ] No special deployment steps required
-- [ ] Database migration required
-- [ ] Configuration changes required
-- [ ] Service restart required
-- [ ] Cache clearing required
-
-**Deployment Instructions:**
-1. Step 1
-2. Step 2
-
----
-
-## 🔍 Post-Merge Checklist
-<!-- Items to check after merging -->
-- [ ] Monitor application performance
-- [ ] Check error logs for new issues
-- [ ] Verify feature works in production
-- [ ] Update project board/roadmap
-- [ ] Notify stakeholders of changes
-
----
-
-**Thanks for contributing to Fincept Terminal! 🚀**
-
-<!--
-Reviewer Guidelines:
-- Review code for logic, style, and best practices
-- Test the changes locally if possible
-- Check that all checklist items are completed
-- Provide constructive feedback
-- Approve when satisfied with the quality
--->
\ No newline at end of file
+## Screenshots
+<!-- For UI changes, include before/after screenshots -->