Skip to content

Commit f791cbf

Browse files
committed
docs: update contributing to add linting section
1 parent 4477343 commit f791cbf

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ information to effectively respond to your bug report or contribution.
1616
* [Run the Unit Tests](#run-the-unit-tests)
1717
* [Run the Integration Tests](#run-the-integration-tests)
1818
* [Make and Test Your Change](#make-and-test-your-change)
19+
* [Lint Your Change](#lint-your-change)
1920
* [Commit Your Change](#commit-your-change)
2021
* [Send a Pull Request](#send-a-pull-request)
2122
* [Documentation Guidelines](#documentation-guidelines)
@@ -117,6 +118,13 @@ If you are writing or modifying a test that creates a SageMaker job (training, t
117118
1. If your changes include documentation changes, please see the [Documentation Guidelines](#documentation-guidelines).
118119
1. If you include integration tests, do not mark them as canaries if they will not run in all regions.
119120

121+
### Lint Your Change
122+
123+
Before submitting, ensure your code meets our quality and style guidelines. Run:
124+
```shell
125+
tox -e flake8,pylint,docstyle,black-check,twine --parallel all
126+
```
127+
Address any errors or warnings before opening a pull request.
120128

121129
### Commit Your Change
122130

0 commit comments

Comments
 (0)