Improve pre-commit usablity for local development #181
Conversation
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
sjmonson
force-pushed
the
feat/pre_commit_improve
branch
from
70226d8 to
1b2a972
Compare
sjmonson
force-pushed
the
feat/pre_commit_improve
branch
from
1b2a972 to
af568a1
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR improves local development usability by enabling auto formatting and fixing of benign linting issues via pre-commit hooks. Key changes include:
- Adding a new auto-fixing hook ("ruff-format") in the pre-commit configuration.
- Modifying GitHub workflows to skip the auto-formatting hook during CI runs.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| .pre-commit-config.yaml | Adds a new "ruff-format" hook with automatic formatting arguments. |
| .github/workflows/main.yml | Updates CI pre-commit run to skip the "ruff-format" hook. |
| .github/workflows/development.yml | Updates development workflow to skip the "ruff-format" hook in CI runs. |
Comments suppressed due to low confidence (2)
.github/workflows/main.yml:55
- Add a comment explaining that skipping the 'ruff-format' hook in CI is intentional to allow auto-formatting exclusively during local development.
run: SKIP=ruff-format pre-commit run --all-files
.github/workflows/development.yml:86
- Add a comment explaining that skipping the 'ruff-format' hook in CI is intentional to allow auto-formatting exclusively during local development.
run: SKIP=ruff-format pre-commit run --all-files
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Enable auto formatting and fixing of benign linting issues in pre-commit. This makes using pre-commit hooks locally a lot less painful.