docs: CONTRIBUTING.md references yapf/Google style guide, but pre-commit actually runs black + flake8 - #1504
Open
PARINAYKAPOOR wants to merge 1 commit into
Conversation
…e8, not yapf) pre-commit is configured to run black (line-length 120) and flake8 (see .pre-commit-config.yaml), but CONTRIBUTING.md still told new contributors to follow the Google Python style guide and use yapf. There is no yapf config anywhere else in the repo, so this was just stale documentation left over from before the project switched formatters. Updated the doc to match what pre-commit actually enforces, so first-time contributors format their code correctly on the first try.
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
1 participant
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.
What's wrong
CONTRIBUTING.mdtells contributors to follow the Google Python style guide and format code withyapf. But.pre-commit-config.yamlonly configuresblack(line-length 120) andflake8— there's noyapfconfig anywhere else in the repo. This is stale documentation, presumably left over from before the project switched formatters.A new contributor following CONTRIBUTING.md as written would install/run the wrong tool (
yapf) and could still fail the actualpre-commitcheck, which runsblack.What this changes
Updates the "Coding Style Guide" section of
CONTRIBUTING.mdto name the tools that are actually enforced (black,flake8), matching.pre-commit-config.yaml. No functional/code changes.Test plan
CONTRIBUTING.mdagainst.pre-commit-config.yaml; confirmedblack+flake8are the only formatters configured repo-wide.yapfconfig (.style.yapf, etc.) — none found outside the doc text being changed.