From cf104338f7292ee1aa7c35cf7539a9f741c76a65 Mon Sep 17 00:00:00 2001 From: Nate Prewitt Date: Fri, 21 Jun 2024 14:17:40 -0600 Subject: [PATCH] Updating contributing guide --- CONTRIBUTING.rst | 15 ++++++--------- setup.cfg | 3 --- 2 files changed, 6 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c4de13054a..718b29489a 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -72,10 +72,11 @@ Reporting An Issue/Feature Codestyle --------- -This project uses flake8 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. +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. @@ -88,11 +89,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 2bf03be6e7..d27c8e2cd9 100644 --- a/setup.cfg +++ b/setup.cfg @@ -10,6 +10,3 @@ requires_dist = [options.extras_require] crt = awscrt==0.20.11 - -[flake8] -ignore = E203,E226,E501,E731,W503,W504