diff --git a/README.md b/README.md index 510d2cf..26c48e3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # workflow-python-lint -Only allows code that passes common linters for Python (black, etc) to merge into main - In the repo settings, open Branches, add a rule for main, and enable Require a pull request before merging. -Turn on Require status checks to pass and select Python CI or the ci job as a required check. + +The workflow in this repository will fail if the python code does not pass a lint test (black) +or any of the tests fail.