π€ Contributing to ConfigFlowο
Thank you for your interest in contributing to ConfigFlow! We welcome contributions from everyone.
π Getting Startedο
Fork the Repository
Click the βForkβ button on GitHub.Clone Your Fork
git clone https://github.com/your-username/configflow.git cd configflow
Install Dependencies
pip install -e .[dev]
Run Tests
pytest
Build Docs
cd docs make html
π οΈ How to Contributeο
π§Ή Code Styleο
Follow PEP 8.
Use type hints wherever possible.
Write unit tests for any new features.
Use Google-style docstrings for public APIs.
π Documentationο
Docs are built using Sphinx.
To edit or improve documentation:
cd docs
make html
Edit .rst or .md files inside docs/source/.
β Submitting Changesο
Create a branch
git checkout -b feature/your-feature
Commit your changes
git commit -m "Add your feature"
Push to your fork
git push origin feature/your-feature
Open a Pull Request on GitHub.
β Questions?ο
Join our GitHub Discussions or open an issue.
Thank you for contributing! β€οΈ