🀝 Contributing to ConfigFlow

Thank you for your interest in contributing to ConfigFlow! We welcome contributions from everyone.


πŸš€ Getting Started

  1. Fork the Repository
    Click the β€œFork” button on GitHub.

  2. Clone Your Fork

    git clone https://github.com/your-username/configflow.git
    cd configflow
    
  3. Install Dependencies

    pip install -e .[dev]
    
  4. Run Tests

    pytest
    
  5. Build Docs

    cd docs
    make html
    

πŸ› οΈ How to Contribute

  • πŸ› Bug Fixes: Check issues or report new ones.

  • ✨ New Features: Suggest ideas via issues or GitHub Discussions.

  • πŸ“¦ Parsers: Add support for new config formats (e.g., TOML, INI).

  • πŸ“ Docs: Improve Sphinx documentation in docs/source/.


🧹 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

  1. Create a branch

    git checkout -b feature/your-feature
    
  2. Commit your changes

    git commit -m "Add your feature"
    
  3. Push to your fork

    git push origin feature/your-feature
    
  4. Open a Pull Request on GitHub.


❓ Questions?

Join our GitHub Discussions or open an issue.


Thank you for contributing! ❀️