Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 1.17 KB

Contributing to xarray_plotly

Thanks for your interest in contributing!

Development Setup

# Clone the repo
git clone https://github.com/FBumann/xarray_plotly.git
cd xarray_plotly

# Install with dev dependencies
uv sync --extra dev

# Install pre-commit hooks
uv run pre-commit install

Running Tests

uv run pytest

Code Style

We use ruff for linting and formatting. Pre-commit hooks will run automatically, or you can run manually:

uv run ruff check --fix .
uv run ruff format .

Making Changes

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/my-feature)
  3. Make your changes
  4. Run tests (uv run pytest)
  5. Commit your changes
  6. Push to your fork and open a Pull Request

Releases

Releases are fully automated via Release Please.

  1. Merge PRs to main using conventional commit prefixes (feat:, fix:, etc.)
  2. Release Please automatically creates/updates a release PR with changelog and version bump
  3. Merge the release PR to publish to PyPI and deploy updated docs