You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: CONTRIBUTE.md
+19Lines changed: 19 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,25 @@
1
1
# Contributing to DFXML's Python code base
2
2
3
3
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
+
4
23
## Installable tools versus in-place scripts
5
24
6
25
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