pre-commit-hooks

Some pre-commit hooks for OpenMMLab projects.

Using pre-commit-hooks with pre-commit

Add this to your .pre-commit-config.yaml

-   repo: https://github.com/open-mmlab/pre-commit-hooks
    rev: v0.1.0  # Use the ref you want to point at
    hooks:
    -   id: check-algo-readme
    -   id: check-copyright
        args: ["dir_to_check"]  # replace the dir_to_check with your expected directory to check

Hooks available

say-hello

A template to show how to implement a pre-commit hook

check-algo-readme

Check whether the abstract and icon exist in the algorithm readme.

  • --debug – print details of abstract and icon in dict format.
  • --dry-run – just dry run, igonre failed use case.
  • --model-index ${MODEL_INDEX} – custom model-index file path.

check-copyright

Check whether the code contains copyright

  • includes – directory to add copyright.
  • --excludes – exclude directory.
  • --suffixes – copyright will be added to files with suffix.

GitHub

View Github