docs: make Code Style section actionable (closes #4421)#4463
Open
Jah-yee wants to merge 1 commit into
Open
Conversation
This was referenced Apr 24, 2026
Closed
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
This PR makes the 'Code Style' section in CONTRIBUTING.md actionable by replacing vague guidance with concrete, runnable commands.
Before
After
uv run ruff check .to check your code anduv run ruff format .to auto-fix formatting issues before committing. Pre-commit hooks enforce these checks.uv run markdownlint docs/to check.Why
The original guidance was vague and not actionable for new contributors. By specifying the exact tools (ruff, markdownlint) and the exact commands to run, new contributors can immediately validate their code style before opening a PR.
Closes #4421