Skip to content

Latest commit

 

History

History
84 lines (49 loc) · 1.5 KB

CONTRIBUTING.rst

File metadata and controls

84 lines (49 loc) · 1.5 KB

Contributing

Contributions to this repository must pass tests and linting.

CI is the canonical source of truth.

Install contribution dependencies

Install Python dependencies in a virtual environment.

pip install --editable '.[dev]'

Spell checking requires enchant. This can be installed on macOS, for example, with Homebrew:

brew install enchant

and on Ubuntu with apt:

apt-get install -y enchant

Install pre-commit hooks:

pre-commit install

Linting

Run lint tools either by committing, or with:

pre-commit run --all-files --hook-stage pre-commit --verbose
pre-commit run --all-files --hook-stage pre-push --verbose
pre-commit run --all-files --hook-stage manual --verbose

Running tests

Run pytest:

pytest

Continuous integration

Tests are run on GitHub Actions. The configuration for this is in `.github/workflows/.

Release Process

Outcomes

  • A new git tag available to install.
  • A new package on PyPI.

Perform a Release

  1. Install GitHub CLI.

  2. Perform a release:

    $ gh workflow run release.yml --repo adamtheturtle/sphinx-substitution-extensions