Skip to content

Commit 9581e5a

Browse files
committed
updated readme to describe purpose of lint.sh file
1 parent e05b35f commit 9581e5a

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,12 @@ To see Python 2 compatible versions of some patterns please check-out the [legac
105105
When everything else is done - update corresponding part of README.
106106

107107
##### Travis CI
108-
Please run `tox` or `tox -e ci37` before submitting a patch to be sure your changes will pass CI.
108+
Please run the following before submitting a patch
109+
- `black .` This lints your code.
110+
111+
Then either:
112+
- `tox` or `tox -e ci37` This runs unit tests. see tox.ini for further details.
113+
- If you have a bash compatible shell use `./lint.sh` This script will lint and test your code. This script mirrors the CI pipeline actions.
109114

110115
You can also run `flake8` or `pytest` commands manually. Examples can be found in `tox.ini`.
111116

0 commit comments

Comments
 (0)