Skip to content

Commit

Permalink
Document pre-commit hook
Browse files Browse the repository at this point in the history
Text adapted from contributions to `case-utils` by @kchason.

Disclaimer:
Participation by NIST in the creation of the documentation of mentioned
software is not intended to imply a recommendation or endorsement by the
National Institute of Standards and Technology, nor is it intended to
imply that any specific software is necessarily the best available for
the purpose.

References:
* casework/CASE-Utilities-Python#37

Signed-off-by: Alex Nelson <alexander.nelson@nist.gov>
  • Loading branch information
ajnelson-nist committed Jun 21, 2024
1 parent f76557f commit a9b4b8f
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
# Contributing to DFXML's Python code base


## Pre-commit

This project uses [the `pre-commit` tool](https://pre-commit.com/) for linting.

`pre-commit` hooks into Git's commit machinery to run a set of linters and static analyzers over each change. To install `pre-commit` into Git's hooks, run one (not both) of the following sets of commands:

```bash
pip install pre-commit
pre-commit --version
pre-commit install
```

Or:

```bash
make
```


## Installable tools versus in-place scripts

The [`dfxml/bin/`](dfxml/bin/) directory contains scripts for interacting with DFXML. Some of the tools are installed in the command-line `$PATH` when the `dfxml` package is installed.
Expand Down

0 comments on commit a9b4b8f

Please sign in to comment.