Skip to content

Commit

Permalink
Updating contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
nateprewitt committed Jun 21, 2024
1 parent 5879a1f commit a414253
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 13 deletions.
18 changes: 8 additions & 10 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,11 @@ ideal report includes:

Codestyle
---------
This project uses flake8 to enforce codstyle requirements. We've codified this
process using a tool called `pre-commit <https://pre-commit.com/>`__. 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 <https://github.com/astral-sh/ruff>`__ to enforce
codstyle requirements. We've codified this process using a tool called
`pre-commit <https://pre-commit.com/>`__. 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 <https://pre-commit.com/#install>`__ to setup pre-commit.
Expand All @@ -51,10 +52,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 <https://github.com/boto/s3transfer/blob/develop/setup.cfg>`__ for the
currently enforced rules.
These checks are also included in our CI setup under the "Lint" workflow which
will provide output on Github for anything missed locally.
3 changes: 0 additions & 3 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,3 @@ requires_dist =

[options.extras_require]
crt = botocore[crt]>=1.33.2,<2.0a0

[flake8]
ignore = E203,E226,E501,W503,W504

0 comments on commit a414253

Please sign in to comment.