Contributing

We welcome contributions to flowerpower-io! Whether it’s reporting a bug, suggesting a new feature, or submitting a pull request, your help is valuable.

Reporting Issues

If you find a bug or have a feature request, please open an issue on our GitHub repository. When reporting a bug, please include:

  • A clear and concise description of the issue.
  • Steps to reproduce the behavior.
  • Expected behavior.
  • Screenshots or error messages, if applicable.
  • Your operating system and Python version.

Submitting Pull Requests

We encourage you to submit pull requests for bug fixes, new features, or improvements. Before submitting a pull request, please:

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your changes: git checkout -b feature/your-feature-name or git checkout -b bugfix/issue-description.
  3. Make your changes and ensure your code adheres to the project’s coding style and conventions.
  4. Write clear commit messages.
  5. Write or update tests to cover your changes.
  6. Ensure all tests pass locally.
  7. Update documentation as needed.
  8. Push your branch to your forked repository.
  9. Open a pull request to the main branch of the upstream repository.

Development Setup

To set up your development environment:

  1. Clone the repository: bash git clone https://github.com/flowerpower/flowerpower-io.git cd flowerpower-io

  2. Install dependencies: We recommend using uv or pixi for dependency management.

    Using uv:

    uv venv
source .venv/bin/activate
uv pip install -e ".[dev,test]"

    Using pixi:

    pixi install

  3. Run tests: bash uv run pytest or if using pixi: bash pixi run pytest

Thank you for contributing to flowerpower-io!