From 7cdce0bb615912b2018bb71e26784919f08ff01d Mon Sep 17 00:00:00 2001 From: Parinay Kapoor Date: Tue, 25 Aug 2026 21:54:39 +0000 Subject: [PATCH] docs: fix CONTRIBUTING.md to reflect actual style tools (black + flake8, 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. --- CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d32cb7c056..97c5effb9a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,9 +2,7 @@ ### Coding Style Guide -In general, we adhere to [Google Python style guide](https://google.github.io/styleguide/pyguide.html), and we recommend to use `yapf` to format your code. - -In this project, we adopted `pre-commit` to automatic check the code style. +This project uses [`black`](https://github.com/psf/black) (line length 120) and `flake8` for code style. Both are run automatically via `pre-commit` (see `.pre-commit-config.yaml` for the exact configuration). To begin with, you should follow the step below to install `pre-commit`.