From 38d6688bd37d3e50c25c3b9587e20b5baeb0228c Mon Sep 17 00:00:00 2001 From: Nate Prewitt Date: Mon, 22 Jul 2024 14:14:19 -0700 Subject: [PATCH] Updating contributing guide (#4215) --- CONTRIBUTING.rst | 15 ++++++--------- setup.cfg | 8 -------- 2 files changed, 6 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 3e9bae73e6..e534516c82 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -40,10 +40,11 @@ ideal report includes: Codestyle --------- -This project uses flake8 to enforce codestyle requirements. We've codified this -process using a tool called `pre-commit `__. pre-commit -allows us to specify a config file with all tools required for code linting, -and surfaces either a git commit hook, or single command, for enforcing these. +This project uses `ruff `__ to enforce +codstyle requirements. We've codified this process using a tool called +`pre-commit `__. pre-commit allows us to specify a +config file with all tools required for code linting, and surfaces either a +git commit hook, or single command, for enforcing these. To validate your PR prior to publishing, you can use the following `installation guide `__ to setup pre-commit. @@ -56,11 +57,7 @@ to automatically perform the codestyle validation: $ pre-commit run This will automatically perform simple updates (such as white space clean up) -and provide a list of any failing flake8 checks. After these are addressed, +and provide a list of any failing checks. After these are addressed, you can commit the changes prior to publishing the PR. These checks are also included in our CI setup under the "Lint" workflow which will provide output on Github for anything missed locally. - -See the `flake8` section of the -`setup.cfg `__ for the -currently enforced rules. diff --git a/setup.cfg b/setup.cfg index 31df55f8b1..5d426dcd84 100644 --- a/setup.cfg +++ b/setup.cfg @@ -9,11 +9,3 @@ requires_dist = [options.extras_require] crt = botocore[crt]>=1.21.0,<2.0a0 - -[flake8] -ignore = E203,E501,W503,W504 -exclude = - docs, - boto3/compat.py, - boto3/data, - .changes