Skip to content

Commit a9b4b8f

Browse files
committed
Document pre-commit hook
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>
1 parent f76557f commit a9b4b8f

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
# Contributing to DFXML's Python code base
22

33

4+
## Pre-commit
5+
6+
This project uses [the `pre-commit` tool](https://pre-commit.com/) for linting.
7+
8+
`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:
9+
10+
```bash
11+
pip install pre-commit
12+
pre-commit --version
13+
pre-commit install
14+
```
15+
16+
Or:
17+
18+
```bash
19+
make
20+
```
21+
22+
423
## Installable tools versus in-place scripts
524

625
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.

0 commit comments

Comments
 (0)