Contributing Guide
Getting Started
- Fork the repository
- Clone your fork:
git clone https://github.com/YOUR_USERNAME/ftex-streamlit.git
- Create a branch:
git checkout -b feature/amazing-feature
Development Setup
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -r requirements-dev.txt
pytest
streamlit run app/main.py
Code Style
- Follow PEP 8
- Use type hints
- Write docstrings
- Keep functions focused
Pull Request Process
- Update documentation
- Add tests
- Ensure tests pass
- Update CHANGELOG.md
- Submit PR