Contributing

Contributions are welcome! Here's how to get started.

Development Setup

git clone https://github.com/yigitoo/financelib.git
cd financelib
pip install -e ".[dev]"

Running Tests

# Run all tests
python -m pytest tests/ -v

# With coverage
python -m pytest tests/ --cov=financelib --cov-report=term-missing

Code Quality

# Lint
ruff check financelib/

# Format
ruff format financelib/

# Type check
mypy financelib/

Building Docs

pip install -e ".[docs]"
mkdocs serve  # http://localhost:8000

Pull Request Guidelines

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Write tests for new functionality
4. Ensure all tests pass
5. Commit: git commit -m 'Add amazing feature'
6. Push: git push origin feature/amazing-feature
7. Open a Pull Request

Code Style

• Use type hints on all public functions
• Write Google-style docstrings
• Follow ruff defaults for formatting
• Keep functions focused and small

Contact

Questions or suggestions? Reach out at gumusyigit101@gmail.com.