Skip to content

docs: CONTRIBUTING.md references yapf/Google style guide, but pre-commit actually runs black + flake8 #1504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PARINAYKAPOOR wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: CONTRIBUTING.md references yapf/Google style guide, but pre-commit actually runs black + flake8 #1504

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down