Adds the guide for reading quality-check results (MIL-003 task 5, issue #19).
Guide: guides/quality-checks.md
Written for a software engineer:
Calling the workflow: a call example and the inputs table with defaults and pinned versions; reference main or a tag, never a pull request branch.
What is checked: tracked *.py with ruff check, ruff format --check and mypy --strict; tracked *.sh with shellcheck and shfmt -d. Untracked files and project tests are not checked; a language without files is skipped with a notice.
Reading a run: the status check, one log group per tool, PASS and FAIL lines, the closing Quality checks failed: ... line, and that paths are relative to working-directory.
Typical failures and fixes: the real messages seen in the trials (F401, Would reformat, missing type annotation, SC2086, a shfmt diff) and the fix for each.
Reproducing a run locally with the exact pinned install commands.
Configuring the tools through the project's own files (pyproject.toml, .shellcheckrc, .editorconfig), with the RepoFoundry switch_case_indent = true example.
When the workflow itself fails: the [configuration] messages and an install failure.
It carries the three findings of the RepoFoundry adoption (RC-039 action item).
Wiki pages changed (rule 8)
New page QualityChecks, generated from the guide, with Danish and Bahasa Malaysia translations (drafts, not yet reviewed by a native reader, #36).
Capabilities (three languages): the quality-checks row.
tools/build_wiki.py knows the new page and its link target; the README capability row is updated.
Tests
188 pass (2 new structure checks for the new translations; the test helper builds the extra source).
Notes
The README row says adoption in RepoFoundry is in review: RepoFoundry PR 76 is not merged, so the row does not claim it adopted.
This is the last open MIL-003 task except #18, which closes when PR 76 merges.
Adds the guide for reading quality-check results (MIL-003 task 5, issue #19).
## Guide: `guides/quality-checks.md`
Written for a software engineer:
- **Calling the workflow:** a call example and the inputs table with defaults and pinned versions; reference `main` or a tag, never a pull request branch.
- **What is checked:** tracked `*.py` with `ruff check`, `ruff format --check` and `mypy --strict`; tracked `*.sh` with `shellcheck` and `shfmt -d`. Untracked files and project tests are not checked; a language without files is skipped with a notice.
- **Reading a run:** the status check, one log group per tool, `PASS` and `FAIL` lines, the closing `Quality checks failed: ...` line, and that paths are relative to `working-directory`.
- **Typical failures and fixes:** the real messages seen in the trials (`F401`, `Would reformat`, missing type annotation, `SC2086`, a shfmt diff) and the fix for each.
- **Reproducing a run locally** with the exact pinned install commands.
- **Configuring the tools** through the project's own files (`pyproject.toml`, `.shellcheckrc`, `.editorconfig`), with the RepoFoundry `switch_case_indent = true` example.
- **When the workflow itself fails:** the `[configuration]` messages and an install failure.
It carries the three findings of the RepoFoundry adoption (RC-039 action item).
## Wiki pages changed (rule 8)
- New page `QualityChecks`, generated from the guide, with Danish and Bahasa Malaysia translations (drafts, not yet reviewed by a native reader, #36).
- `Capabilities` (three languages): the quality-checks row.
- `tools/build_wiki.py` knows the new page and its link target; the README capability row is updated.
## Tests
188 pass (2 new structure checks for the new translations; the test helper builds the extra source).
## Notes
- The README row says adoption in RepoFoundry is **in review**: [RepoFoundry PR 76](https://git.tirsystem.com/TirSystem-BashScript/RepoFoundry/pulls/76) is not merged, so the row does not claim it adopted.
- This is the last open MIL-003 task except #18, which closes when PR 76 merges.
Closes #19
Explain how to call the shared quality-checks workflow, read a failed run,
fix the typical findings of ruff, mypy, shellcheck and shfmt, reproduce a
run locally and configure the tools through the project's own files,
including the shfmt .editorconfig route found in the RepoFoundry trial.
Add the QualityChecks wiki page with its Danish and Bahasa Malaysia
translations, update the capability row and teach build_wiki.py the page.
Task: MIL-003#5
Tirsvad
merged commit 2ce02698e5 into main2026-10-10 14:26:39 +02:00
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Adds the guide for reading quality-check results (MIL-003 task 5, issue #19).
Guide:
guides/quality-checks.mdWritten for a software engineer:
mainor a tag, never a pull request branch.*.pywithruff check,ruff format --checkandmypy --strict; tracked*.shwithshellcheckandshfmt -d. Untracked files and project tests are not checked; a language without files is skipped with a notice.PASSandFAILlines, the closingQuality checks failed: ...line, and that paths are relative toworking-directory.F401,Would reformat, missing type annotation,SC2086, a shfmt diff) and the fix for each.pyproject.toml,.shellcheckrc,.editorconfig), with the RepoFoundryswitch_case_indent = trueexample.[configuration]messages and an install failure.It carries the three findings of the RepoFoundry adoption (RC-039 action item).
Wiki pages changed (rule 8)
QualityChecks, generated from the guide, with Danish and Bahasa Malaysia translations (drafts, not yet reviewed by a native reader, #36).Capabilities(three languages): the quality-checks row.tools/build_wiki.pyknows the new page and its link target; the README capability row is updated.Tests
188 pass (2 new structure checks for the new translations; the test helper builds the extra source).
Notes
Closes #19