@@ -40,10 +40,11 @@ ideal report includes:
40
40
41
41
Codestyle
42
42
---------
43
- This project uses flake8 to enforce codestyle requirements. We've codified this
44
- process using a tool called `pre-commit <https://pre-commit.com/ >`__. pre-commit
45
- allows us to specify a config file with all tools required for code linting,
46
- and surfaces either a git commit hook, or single command, for enforcing these.
43
+ This project uses `ruff <https://github.com/astral-sh/ruff >`__ to enforce
44
+ codstyle requirements. We've codified this process using a tool called
45
+ `pre-commit <https://pre-commit.com/ >`__. pre-commit allows us to specify a
46
+ config file with all tools required for code linting, and surfaces either a
47
+ git commit hook, or single command, for enforcing these.
47
48
48
49
To validate your PR prior to publishing, you can use the following
49
50
`installation guide <https://pre-commit.com/#install >`__ to setup pre-commit.
@@ -56,11 +57,7 @@ to automatically perform the codestyle validation:
56
57
$ pre-commit run
57
58
58
59
This will automatically perform simple updates (such as white space clean up)
59
- and provide a list of any failing flake8 checks. After these are addressed,
60
+ and provide a list of any failing checks. After these are addressed,
60
61
you can commit the changes prior to publishing the PR.
61
62
These checks are also included in our CI setup under the "Lint" workflow which
62
63
will provide output on Github for anything missed locally.
63
-
64
- See the `flake8 ` section of the
65
- `setup.cfg <https://github.com/boto/boto3/blob/develop/setup.cfg >`__ for the
66
- currently enforced rules.
0 commit comments