Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
248 lines (188 loc) · 7.13 KB

CONTRIBUTING.md

File metadata and controls

248 lines (188 loc) · 7.13 KB

Contributing to Fincept Terminal

Welcome! Fincept Terminal is an open-source native C++20 financial intelligence platform with 40+ screens, embedded Python analytics, and 100+ data connectors.

Table of Contents

Ways to Contribute

Area Examples
Code Bug fixes, new features, new screens, new analytics
Documentation Improve guides, add examples
Testing Report bugs, write tests, review PRs
Design UI/UX improvements, themes
Data New data sources, API integrations, Python scripts

Tech Stack

Layer Technologies
Language C++20 — MSVC 19.38 (VS 2022 17.8) / GCC 12.3 / Apple Clang 15.0
UI Qt 6.7.2 Widgets (pinned EXACT)
Charts Qt6 Charts
Networking Qt6 Network + Qt6 WebSockets
Database Qt6 Sql (SQLite)
Serialization QJsonDocument
Analytics Embedded Python 3.11.9 (1300+ scripts)
Build CMake 3.27.7 + Ninja 1.11.1 (pinned)

Language-Specific Guides:

Getting Started

Prerequisites (pinned versions — enforced by CMake)

Tool Version
C++ compiler MSVC 19.38 (VS 2022 17.8) / GCC 12.3 / Apple Clang 15.0 (Xcode 15.2)
CMake 3.27.7 — cmake.org
Ninja 1.11.1 — releases
Qt 6.7.2 (LTS) — Qt Online Installer
Python 3.11.9 — python.org
Git latest — git-scm.com

The CMake build fails fast with a clear error message when toolchain versions don't match.

Setup (fastest — automated)

# Clone + auto-install toolchain + Qt 6.7.2 + build
git clone https://github.com/Fincept-Corporation/FinceptTerminal.git
cd FinceptTerminal
./setup.sh       # Linux / macOS
setup.bat        # Windows (run from VS 2022 Developer Cmd)

The setup script uses aqtinstall to fetch Qt 6.7.2 exactly.

Setup (manual — using CMake presets)

git clone https://github.com/Fincept-Corporation/FinceptTerminal.git
cd FinceptTerminal/fincept-qt

# Install Qt 6.7.2 first (Qt Online Installer or: pip install aqtinstall && aqt install-qt ...)

# Configure + Build (pick your platform preset)
cmake --preset win-release     && cmake --build --preset win-release     # Windows
cmake --preset linux-release   && cmake --build --preset linux-release   # Linux
cmake --preset macos-release   && cmake --build --preset macos-release   # macOS

# Run
./build/linux-release/FinceptTerminal                                           # Linux
./build/macos-release/FinceptTerminal.app/Contents/MacOS/FinceptTerminal        # macOS
.\build\win-release\FinceptTerminal.exe                                         # Windows

Verify Installation

cmake --version     # 3.27.7
python --version    # 3.11.9
# Compiler:
cl            /   # MSVC 19.38+ (Windows)
g++ --version /   # 12.3+       (Linux)
clang --version   # 15.0+       (macOS, Xcode 15.2)

Project Architecture

Source Layout (fincept-cpp/src/)

src/
├── main.cpp                # Entry point, GLFW/OpenGL setup
├── app.cpp/h               # App state machine, routing
│
├── core/                   # Shared infrastructure
│   ├── config.h            # Constants (URLs, timeouts, versions)
│   ├── event_bus.h         # Pub/sub messaging
│   ├── logger.h            # Structured logging
│   └── result.h            # Result<T> error handling
│
├── ui/                     # Reusable ImGui widgets
├── http/                   # HTTP client (libcurl)
├── storage/                # SQLite database
├── auth/                   # Authentication
├── python/                 # Python runtime bridge
├── mcp/                    # MCP integration
├── trading/                # Trading engine + brokers
├── portfolio/              # Portfolio management
│
└── screens/                # 40+ terminal screens
    ├── dashboard/
    ├── markets/
    ├── crypto_trading/
    ├── research/
    ├── quantlib/
    ├── ai_chat/
    ├── economics/
    ├── geopolitics/
    └── ...

Python Scripts (fincept-cpp/scripts/)

scripts/
├── Analytics/              # 34 analytics modules
│   ├── equityInvestment/   # Stock valuation, DCF
│   ├── portfolioManagement/# Portfolio optimization
│   ├── derivatives/        # Options pricing, Greeks
│   ├── fixedIncome/        # Bond analytics
│   └── ...
│
├── agents/                 # AI agents
├── strategies/             # Trading strategies
├── technicals/             # Technical analysis
└── *.py                    # 80+ data fetchers

Development Workflow

Branch Naming

feature/add-options-screen
fix/chart-rendering-crash
docs/update-architecture

Making Changes

  1. Create branch from main
  2. Follow the appropriate language guide
  3. Build and test locally
  4. Commit with clear messages

Commit Format

type: short description

Types: feat, fix, docs, refactor, test, chore, perf

Pull Request Process

Before Submitting

  • Code compiles without warnings (-Wall -Wextra)
  • No duplicated code — use core/ and ui/widgets/
  • Screens don't call HTTP directly (use data services)
  • New .cpp files added to CMakeLists.txt
  • .clang-format applied
  • Tested in development mode

PR Template

## Description
Brief description

## Type
- [ ] Bug fix
- [ ] New feature / screen
- [ ] Documentation

## Testing
How was this tested?

## Screenshots (if UI)

Language-Specific Guides

Guide Coverage
C++ Guide Screens, services, core infrastructure, widgets
Python Guide Analytics modules, data fetchers, AI agents

Getting Help

Channel Link
Issues GitHub Issues
Discussions GitHub Discussions
Discord Join Discord
Email support@fincept.in

Good First Issues

Look for labels: good first issue, help wanted, documentation

Repository: https://github.com/Fincept-Corporation/FinceptTerminal Version: 4.0.2 License: AGPL-3.0