ComPWA repository policy

Contents

ComPWA repository policy#

This repository sets policies for repositories of the ComPWA organization. The policies are enforced through pre-commit with the use of a number of pre-commit hooks as defined by .pre-commit-hooks.yaml. The check-dev-files in particular can be used as a cookie cutter for new repositories.

Usage#

Add a .pre-commit-config.yaml file to your repository and list which hooks you want to use:

repos:
  - repo: https://github.com/ComPWA/policy
    rev: ""
    hooks:
      - id: check-dev-files
        args:
          - --repo-name="short name for your repository"

and install and activate pre-commit as follows:

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

The ComPWA/policy repository provides the check-dev-files hook. The notebook formatting hooks that used to be served from here now live in ComPWA/nbhooks.

Contents