We welcome contributions! Here's how to get started.
- Fork and clone the repo
- Install dependencies:
pip install -r requirements.txt - Run tests:
python -m pytest - Create a branch:
git checkout -b feature/your-feature
- Python 3.12+
- Type hints required
- Docstrings for all public functions
- ECOA/FCRA compliance must be maintained in ALL scoring changes
CRITICAL: Any changes to the scoring model MUST:
- Maintain ECOA compliance (no protected class factors)
- Generate adverse action notices for denials
- Pass all existing tests
- Be documented in MODEL_VALIDATION.md
- Include factor weight justification
- Update relevant documentation
- Add/update tests for new features
- Ensure CI passes
- Request review from maintainers
This is a regulated financial product. Contributors must understand ECOA, FCRA, and Reg B requirements before modifying scoring logic.