Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (42 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 1.46 KB

Contributing

Development setup

  1. Clone the repository:

    git clone https://github.com/wild-edge/wildedge-python.git
cd wildedge-python

  2. Install dependencies:

    uv sync --group dev

  3. Run tests:

    uv run pytest

  4. Run tests across Python versions:

    uv run tox

Code style

  • Use ruff for linting and formatting:

    uv run ruff check .
uv run ruff format .

  • Follow PEP 8 and PEP 484 (type hints).

Pull requests

  1. Fork the repository and create a feature branch off devel.
  2. Make your changes and ensure tests pass.
  3. Update documentation if needed.
  4. Submit a pull request targeting devel with a clear description of the changes.

Release process

Releases follow a release/<version> branching flow:

  1. Cut a release/<version> branch from devel.
  2. Bump the version in pyproject.toml.
  3. Open a pull request targeting main. CI will automatically run the full compatibility matrix and post a changelog preview comment.
  4. Once merged, tag the commit as v<version>. The release workflow publishes to PyPI and creates a GitHub release.

Reporting issues

  • Use GitHub Issues for bugs and feature requests.
  • Include steps to reproduce, Python version, OS, and relevant logs.

License

This project is licensed under the Business Source License 1.1. By contributing, you agree that your contributions will be licensed under the same terms.