fix(CONTRIBUTING): correct just check comment to reflect fmt + lint behavior#73
Merged
Conversation
…ehavior The inline comment described `just check` as "verify workspace compiles" but the recipe actually runs taplo fmt, taplo check, cargo fmt, and cargo clippy --fix — formatting and linting with autofixes, not a compile check. Closes #63 https://claude.ai/code/session_01JXbwWw7vxy9GW3wSh9Swi3
There was a problem hiding this comment.
Pull request overview
Updates the CONTRIBUTING.md “Running” snippet so the inline comment for just check accurately reflects what the justfile check recipe actually does (formatting + linting with autofixes), aligning contributor expectations with real side effects.
Changes:
- Replace the misleading “verify workspace compiles” comment with “fmt + lint (autofixes where possible)” next to
just check.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
just checkinCONTRIBUTING.mdsaid "verify workspace compiles" but the recipe actually runstaplo fmt,taplo check,cargo fmt, andcargo clippy --fix— formatting and linting with autofixes, not a compile check.CLAUDE.mdalready describes it.Test plan
CONTRIBUTING.mdlines 51–57 — the comment next tojust checkshould describe formatting and linting, not compiling.just checkin a clean working tree — confirm it runstaplo fmt,cargo fmt, andcargo clippy --fixas described.Closes #63
Related Links