/policy

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

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

ComPWA repository policy

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

This repository sets the policies for developer environment in repositories if the ComPWA organization (See our Help developing page). The policies are automatically enforced through pre-commit.

Usage

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

repos:
  - repo: https://github.com/ComPWA/policy
    rev: ""
    hooks:
      - id: check-dev-files
      - id: fix-nbformat-version
      - id: set-nb-cells

then run

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

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