Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 831 Bytes

File metadata and controls

20 lines (15 loc) · 831 Bytes

Contributing

Thanks for your interest in improving CubeDynamics!

  • Read the full guidelines in docs/dev/contributing.md.
  • Set up a development environment with:
  • python -m pip install -e ".[dev]"
    • pytest -m "not integration" -q
  • Build docs locally with mkdocs serve to preview changes.
  • Open issues or pull requests on GitHub for discussion and review.

We follow the Contributor Covenant Code of Conduct (see CODE_OF_CONDUCT.md).

Releasing

  1. Install release tooling: python -m pip install -e ".[test]"
  2. Build the artifacts: python -m build
  3. Validate metadata: python -m twine check dist/*
  4. Upload to PyPI (requires an API token or trusted publishing): python -m twine upload dist/*
  5. Optionally create a Git tag and GitHub release that matches the PyPI version.