Skip to content

Update README to clarify linting and merge process #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PE-VCS merged 1 commit into from
Nov 5, 2025
Merged

Update README to clarify linting and merge process #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.