Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (41 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

60 lines (41 loc) · 1.82 KB

Welcome

Hi there! Welcome to the tilesets-cli contributing document. Issues, comments, and pull requests are welcome. Please tag @mapbox/maps-api for any questions or reviews.

Installation

Install uv (https://docs.astral.sh/uv/) and then clone the repo and cd into the folder:

# clone
git clone git@github.com:mapbox/tilesets-cli.git
cd tilesets-cli

# install deps (creates .venv)
uv sync --group dev

# include optional estimate-area dependencies
uv sync --group dev --extra estimate-area

# confirm installation was successful
uv run tilesets --help
uv run tilesets --version

Pre-commit hooks

We use pre-commit hooks to auto-format and validate code before committing. pre-commit is included with the dev dependency group, but you must run:

$ uv run pre-commit install

within the repo to have the actions specified in .pre-commit-config.yaml registered.

Release process

Releases to PyPi are handled via Github Actions and GitHub tags. Once changes have been merged to master:

  1. Update the version in pyproject.toml
  2. Update the changelog
  3. Commit changes to your branch. For example git commit -am '0.2.0' && git push origin HEAD
  4. Get a review and merge your changes to master.
  5. Get the latest changes locally from master git checkout master && git pull origin master
  6. Tag on GitHub with git tag and push tags. For example git tag -a v0.2.0 -m 'v0.2.0' && git push --tags
  7. Watch for tag build on Github Actions at https://github.com/mapbox/tilesets-cli/actions
  8. Once Github Actions completes successfully, look for the release at https://pypi.org/project/mapbox-tilesets/#history

Tests

All tests are runnable with pytest. pytest is installed via the dev dependency group:

uv sync --group dev

Running tests

uv run pytest