Skip to content

Commit 38d6688

Browse files
authored
Updating contributing guide (#4215)
1 parent 136c33b commit 38d6688

File tree

2 files changed

+6
-17
lines changed

2 files changed

+6
-17
lines changed

CONTRIBUTING.rst

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,11 @@ ideal report includes:
4040

4141
Codestyle
4242
---------
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.
4748

4849
To validate your PR prior to publishing, you can use the following
4950
`installation guide <https://pre-commit.com/#install>`__ to setup pre-commit.
@@ -56,11 +57,7 @@ to automatically perform the codestyle validation:
5657
$ pre-commit run
5758
5859
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,
6061
you can commit the changes prior to publishing the PR.
6162
These checks are also included in our CI setup under the "Lint" workflow which
6263
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.

setup.cfg

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,3 @@ requires_dist =
99

1010
[options.extras_require]
1111
crt = botocore[crt]>=1.21.0,<2.0a0
12-
13-
[flake8]
14-
ignore = E203,E501,W503,W504
15-
exclude =
16-
docs,
17-
boto3/compat.py,
18-
boto3/data,
19-
.changes

0 commit comments

Comments
 (0)