Skip to content

docs: sync Ruff quality gate documentation #62

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
CoderDeltaLAN merged 1 commit into from
Jun 16, 2026
Merged

docs: sync Ruff quality gate documentation #62

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This project has a published GitHub Release line, but no stable support or API g

### Changed

- Added Ruff linting to local checks and CI by installing project development dependencies before running `./scripts/check.sh`.
- Synced support, security, README, and release-truth documentation after the published `v0.2.0` GitHub Release.
- Added CLI output examples and governance rules reference documentation after the `v0.2.0` tag.

Expand Down
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,7 @@ The local check suite verifies:

- Python syntax;
- unit tests;
- Ruff lint checks;
- UTF-8 text files;
- LF line endings;
- final newline;
Expand All @@ -354,7 +355,7 @@ Current verified local result on `main`:

The exact unit test count may change as coverage evolves. The source of truth is the current `./scripts/check.sh` output and the matching GitHub Actions run for `main`.

CI runs the same local check script through GitHub Actions.
CI installs project development dependencies and then runs the same local check script through GitHub Actions.

The required status check for `main` is:

Expand Down