Skip to content

v1.10.10: PR layout — automated checks vs manual QA, results as a table - #64

Closed
gitluis wants to merge 3 commits into
masterfrom
docs-automated-checks-manual-qa
Closed

gitluis wants to merge 3 commits into
masterfrom
docs-automated-checks-manual-qa

Conversation

@gitluis

@gitluis gitluis commented Nov 5, 2026 •

Copy link
Copy Markdown
Owner

Summary

PR descriptions mixed two different things under "testing": the scripted checks run in a sandbox, and the steps a reviewer follows by hand before merging. A passing status line could read as "tested", even though nothing had run in a real browser with a real folder. This adds a PR layout section to CLAUDE.md §0 that keeps them apart:

  • Automated checks: scripted sandbox checks, in a collapsed section whose title is the status line (count · environment · SHA · date). Inside: a # · Check · Area · Result · Notes table, with long logs in nested collapsed blocks. Each run replaces the section in place.
  • Manual QA: the hand-run script, in a collapsed "Manual QA steps" section, recorded by a "Manual QA passed in Edge/Chrome with a real folder" box in "Please check before merging".
  • When to re-run: a full run for commits that change the PR's content, a light run (version lines, JS syntax, boot) after a master merge or renumber. The SHA in the section's title shows whether the checks match the latest commit.

This PR uses the layout itself.

What changed

Open PRs moved to this layout

All 47 other open PRs (drafts included) were moved on 2026-11-04 by editing their descriptions only, with no commits and no re-runs:

Relation to #61 and #62

Not verified

  • ⏭️ Views using CDN libraries (PapaParse, Chart.js, Day.js, marked, DOMPurify): they can't load in the sandbox, so the boot check covers the static shell and Settings only. This PR doesn't touch code that uses them.
  • How the collapsed sections and tables look in GitHub's mobile app.
Automated checks: 6/7 passed · headless Chromium 153 · bd682da · 2026-11-04
# Check Area Result Notes
1 Version lines Docs ✅ Pass v1.10.10 in README ×2, index.html, CLAUDE.md ×2, Settings; no v1.10.5 left outside CHANGELOG history
2 CHANGELOG history untouched Docs ✅ Pass diff against master only adds the [1.10.10] entry; 0 lines removed or changed
3 JS syntax Code ✅ Pass node --check on all 16 files in js/
4 No bank names Rules ✅ Pass 0 matches in added lines
5 Boot + Settings UI ✅ Pass footer and Settings → General show v1.10.10; no errors besides blocked CDN loads
6 CLAUDE.md renders on GitHub Docs ✅ Pass "PR layout": 2 tables, numbered list of sections, no raw Markdown, no leftover "PR comment" wording, migration line present
7 Views using CDN libraries UI ⏭️ Skipped CDN libraries can't load in the sandbox; this PR doesn't touch code that uses them
Log: 5 — Boot + Settings
footer: True
settings: True
non-cdn errors: [] all: 6
Chrome 153.0.0.0

All 6 console errors are the blocked CDN script loads.

Manual QA steps
  1. Files changed tab: only CHANGELOG.md, CLAUDE.md, README.md, index.html and js/views-settings.js are listed.
  2. CLAUDE.md on this branch: under §0, a "PR layout" section sits between "What every PR includes" and "Stacked PRs". It opens with a table comparing "Automated checks" and "Manual QA".
  3. Same section: the collapsed sections are listed in the order Automated checks → How to reproduce the bug → Manual QA steps, and a second table says when to re-run (full run, light run, no run).
  4. This description: the "Automated checks" section above is collapsed, and its title reads "6/7 passed · headless Chromium 153 · bd682da · 2026-11-04".
  5. Open it: a table with the columns # · Check · Area · Result · Notes, and a nested "Log: 5 — Boot + Settings" block that opens when clicked.
  6. SHA match: the Commits tab shows bd682da as the latest commit, the same SHA as in that title.
  7. This section: "Manual QA steps" was collapsed until you opened it, and the steps show as a numbered list, not raw Markdown.
  8. Another open PR (e.g. v1.16.1: Fix "Clear transaction edits" wiping every transaction when the browser database is empty #24): its description has a collapsed "Automated checks: earlier run, not re-run · 93a373a" section holding the old results, "Manual QA steps" instead of "How to test", and no "Test results" comment left.
  9. CHANGELOG.md: the top entry is ## [1.10.10] — 2026-11-04. The [1.10.5] entry below it is unchanged.
  10. Open the app (any browser): the sidebar footer and Settings → General show v1.10.10.

Please check before merging

https://claude.ai/code/session_013Z8iBUuvoYJaEX18vphJPz


Generated by Claude Code

gitluis and others added 3 commits November 5, 2026 02:55
CLAUDE.md §0 gets a "PR layout" section. The status line reads
"Automated checks" and covers only scripted sandbox checks; the hand-run
script is a collapsed "Manual QA steps" section with a "Manual QA passed"
box in "Please check before merging". Each automated run is one PR
comment with a # · Check · Area · Result · Notes table and long logs
collapsed below it. Earlier comments and CHANGELOG entries are untouched.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013Z8iBUuvoYJaEX18vphJPz
The "Automated checks" section moves from a PR comment into a collapsed
section in the description; its title is the status line (count ·
environment · SHA · date). Each run replaces it in place. Adds when to
re-run: full run for content commits, light run after a master merge
or renumber.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013Z8iBUuvoYJaEX18vphJPz
…iption

Replaces "earlier results stay as they are" with how they were migrated:
moved unchanged into "Automated checks: earlier run, not re-run", old
"Test results" comments deleted, table format from the next run on.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013Z8iBUuvoYJaEX18vphJPz

gitluis commented Nov 5, 2026 •

Copy link
Copy Markdown
Owner Author

Closed in favor of #65, which adds .github/pull_request_template.md as the PR layout standard. Decision: @gitluis, 2026-11-05, in chat (https://claude.ai/code/session_013Z8iBUZ1y4fG6SBtXbANs4):

I want to stick to the template, so #65 is the way to go, we close PRs contradicting, clashing or opposing to these changes.

Why this one clashes: it collapses Automated checks, reproduction and Manual QA in <details>, uses a # · Check · Area · Result · Notes table and a Please check before merging section; the template has no <details>, a Check · Result · Notes table and Check before merging.

🤖 Generated with Claude Code


Generated by Claude Code

@gitluis gitluis closed this Nov 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant