Update CLAUDE.md to simplify pre-commit documentation#18710
Merged
harupy merged 1 commit intomlflow:masterfrom Nov 11, 2025
Merged
Update CLAUDE.md to simplify pre-commit documentation#18710harupy merged 1 commit intomlflow:masterfrom
harupy merged 1 commit intomlflow:masterfrom
Conversation
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
harupy
commented
Nov 6, 2025
Comment on lines
-240
to
-257
| **Note about external tools**: Some pre-commit hooks require external tools that aren't Python packages: | ||
|
|
||
| - `taplo` - TOML formatter | ||
| - `typos` - Spell checker | ||
| - `conftest` - Policy testing tool | ||
|
|
||
| To install these tools: | ||
|
|
||
| ```bash | ||
| # Install all tools at once (recommended) | ||
| uv run --only-group lint bin/install.py | ||
| ``` | ||
|
|
||
| This automatically downloads and installs the correct versions of all external tools to the `bin/` directory. The tools work on both Linux and ARM Macs. | ||
|
|
||
| These tools are optional. Use `SKIP=taplo,typos,conftest` if they're not installed. | ||
|
|
||
| **Note**: If the typos hook fails, you only need to fix typos in code that was changed by your PR, not pre-existing typos in the codebase. |
Member
Author
There was a problem hiding this comment.
These were added before the install-bin was introduced.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR simplifies the pre-commit documentation by consolidating the installation process and removing redundant information about external tools. The key change is to automatically handle external tool installation through the install-bin pre-commit hook instead of requiring manual setup.
- Adds the
install-binhook execution to the setup instructions - Removes detailed documentation about manual external tool installation
- Removes instructions for skipping hooks when external tools are unavailable
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
|
@harupy do we need this PR by 3.6.0? |
Member
Author
|
@B-Step62 No, removed the label :) |
BenWilson2
pushed a commit
to BenWilson2/mlflow
that referenced
this pull request
Nov 14, 2025
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
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
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.
🛠 DevTools 🛠
Install mlflow from this PR
For Databricks, use the following command:
What changes are proposed in this pull request?
Simplifies the pre-commit setup documentation in CLAUDE.md by:
install-bincommand to the initial setupThe documentation now assumes all tools are properly installed via
install-bin, making the setup process clearer for new contributors.How is this PR tested?
Does this PR require documentation update?
Release Notes
Is this a user-facing change?
How should the PR be classified in the release notes? Choose one:
rn/none- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionShould this PR be included in the next patch release?
🤖 Generated with Claude Code