Skip to content
/ policy Public

Pre-commit hooks that ensure that ComPWA repositories have a similar developer set-up

License

Notifications You must be signed in to change notification settings

ComPWA/policy

Repository files navigation

Repository maintenance

BSD 3-Clause license Spelling checked GitPod pytest pre-commit.ci status code style: prettier Code style: black Ruff

This repository is to standardize the developer environment of Python packages by the ComPWA organization. The maintenance is performed through pre-commit.

See also the develop page.

Usage

Add a .pre-commit-config.yaml file to your repository with the following content:

repos:
  - repo: https://github.com/ComPWA/repo-maintenance
    rev: ""
    hooks:
      - id: check-dev-files
      - id: fix-nbformat-version
      - id: format-setup-cfg
      - id: pin-nb-requirements
      - id: set-nb-cells

then run

pre-commit autoupdate --repo=https://github.com/ComPWA/repo-maintenance

This example lists all available hooks (listed here as ids) ― you can remove some of them.