docs: note virtual environment requirement for pre-commit hooks#745
Merged
ajbozarth merged 1 commit intoMar 26, 2026
Merged
Conversation
Some hooks require tools from dev dependency groups to be on PATH. Add note to installation steps and common issues table directing contributors to activate the virtual environment before committing. Relates to generative-computing#744. Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
Contributor
|
The PR description has been updated. Please fill out the template for your PR to be reviewed. |
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
psschwei
approved these changes
Mar 25, 2026
Merged
via the queue into
generative-computing:main
with commit Mar 26, 2026
9f2e1f0
10 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Misc PR
Type of PR
Description
Adds a note to the installation steps and common issues table clarifying that some pre-commit hooks require dev tools (from the
lintandtypecheckdependency groups) to be on PATH, and directs contributors to activate the virtual environment before committing.This was introduced in #709 which moved the ruff hooks to
language: system, requiring the tools to be available outside the virtualenv.Testing