🤝 Contributing to WealthFam
Welcome to the WealthFam Engineering Hub. We follow a "Precision First" engineering philosophy—every commit should be accurate, every feature should be idempotent, and every bug should be documented.
🏗️ Core Contribution Areas
1. Ingestion Microservice (Parser)
The Parser is the gateway for all Precision data. We are always looking for new regex templates for international and regional banks.
- Location:
parser/core/templates/ - Standard: Follow the existing YAML structure. Each template MUST include test cases for:
- Successful parsing of debit/credit.
- Identification of account masks.
- Balance discovery (where available).
2. Mobile Native Widgets (Flutter)
WealthFam Mobile uses a minimalist, high-performance Material 3 design system.
- Location:
mobile_app/lib/widgets/ - Guidelines: Use the built-in
PrecisionCardandNeonLabelcomponents. Avoid external styling libraries.
3. Backend Analytical Engines (FastAPI)
The backend handles heavy lifting (XIRR, Portfolio rebalancing, AI Triage).
- Location:
backend/app/services/ - Requirement: Use Type Hints throughout. All SQL queries must be optimized for DuckDB’s columnar architecture.
🛠️ Development Standards
🧬 Commit Message Standards
We use a Precision commit standard for easy auditing:
feat(scope): ...— New functional behavior.fix(scope): ...— Bug fix (always include the error hash if possible).infra(scope): ...— Changes to Docker or deployment scripts.docs(scope): ...— Documentation updates.
🧪 Quality Assurance
- Linting: Run
flake8oreslintbefore pushing. - Schema Integrity: If modifying models, provide a migration patch in
backend/app/core/migrations/. - Idempotency Check: Ensure your operations (especially in the Parser) can be run safely multiple times.
📝 The RFC Process
Major architectural shifts require a Request for Comments. Reference the RFC Process before starting significant refactors.
*Accuracy Above All · Zero Manual Entry · Precision Integrity*