Skip to content

Add pre-commit hook setup instructions to contributing guide #2882

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
koxudaxi merged 3 commits into from
Dec 31, 2025
Merged

Add pre-commit hook setup instructions to contributing guide #2882

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f8d1355
Add pre-commit hook setup instructions to contributing guide
koxudaxi Dec 31, 2025
1739427
Use uv tool install prek instead of .tox path
koxudaxi Dec 31, 2025
6f438f2
Add config-types instruction to CLI option guide
koxudaxi Dec 31, 2025
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
19 changes: 13 additions & 6 deletions docs/development-contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,26 @@ $ tox run -e dev

.tox/dev is a Python environment you can use for development purposes

## 5. Create new branch and rewrite code.
## 5. Install pre-commit hooks
$ uv tool install prek
$ prek install

## 6. Create new branch and rewrite code.
$ git checkout -b new-branch

## 6. Run unittest under Python 3.13 (you should pass all test and coverage should be 100%)
## 7. Run unittest under Python 3.13 (you should pass all test and coverage should be 100%)
$ tox run -e 3.13

## 7. Format and lint code (will print errors that cannot be automatically fixed)
## 8. Format and lint code (will print errors that cannot be automatically fixed)
$ tox run -e fix

## 8. Check README help text is up to date
## 9. Check README help text is up to date
$ tox run -e readme

## 9. Check CLI documentation is up to date
## 10. Check CLI documentation is up to date
$ tox run -e cli-docs

## 10. Commit and Push...
## 11. Commit and Push...
```

## ➕ Adding a New CLI Option
Expand Down Expand Up @@ -111,6 +115,9 @@ $ python scripts/build_cli_docs.py

# Verify docs are correct
$ tox run -e cli-docs

# If you modified config.py, regenerate config TypedDicts
$ tox run -e config-types
```

### 🔧 Troubleshooting
Expand Down
Loading