Skip to content

Contributing to Portfolio Management Toolkit

Thank you for helping to improve the toolkit. The canonical guide lives in the repository root, but this page summarizes the fastest path to a productive workflow.

Quick Start

  1. Clone the repo and install dependencies with Python 3.12:
git clone https://github.com/jc1122/portfolio_management.git
cd portfolio_management
pip install -r requirements.txt
pip install -r requirements-dev.txt
pip install -e .
pre-commit install

  1. Follow the Ruff-only tooling path (make fmt, make lint, make type, etc.) so every change passes formatting, linting, and type checking.

  2. Run the tests you touched (make test-unit for fast loops, make test for completeness) and rerun make pre-commit before opening a PR.

Development Workflow

  • Work in a focused branch (e.g., feature/… or fix/…).
  • Keep commits descriptive with conventional prefixes (feat:, fix:, docs:).
  • Update docs and samples when behavior changes, and capture acceptance criteria in tests or documentation.

Full Guidelines

For the full contributing playbook (testing matrix, documentation expectations, PR reviews, and common issues), read the root-level CONTRIBUTING.md.