Skip to content

Explain pre-commit in CONTRIBUTING.md #618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanjmcdougall merged 1 commit into from
May 11, 2025
Merged

Explain pre-commit in CONTRIBUTING.md #618

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ feature is aligned with the project's goals and that there is no duplication of

## Setup

### Development Environment

[uv](https://github.com/astral-sh/uv) is required to install the development
environment. You can install it using the instructions here:

Expand All @@ -22,6 +24,15 @@ Then with the current working directory set to the project root, run:
uv sync
```

### Pre-commit Hooks

This project uses the `pre-commit` framework to manage Git hooks. To install the hooks,
run:

```shell
uv run pre-commit install
```

## Testing

### Running the Test Suite
Expand Down