Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 925 Bytes

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 925 Bytes

Contributing to PyTorch-OOD

All kinds of contributions are welcome, including but not limited to the following.

  • Adding additional detectors
  • Fixing typos or bugs
  • Improving documentation

Workflow

  1. fork and pull the latest PyTorch-OOD repository
  2. checkout a new branch (do not use master/dev branch for PRs)
  3. commit your changes
  4. create a PR

If you plan to add some new features that involve large changes, it is encouraged to open an issue for discussion first.

Code style

We use pre-commit hook that checks and formats the code for automatically on every commit. The config for a pre-commit hook is stored in .pre-commit-config.

After you clone the repository, you will need to install pre-commit and initialize the pre-commit hook.

pip install -U pre-commit

From the repository folder

pre-commit install