Skip to content

v1.10.8: PR layout — steps collapsed, test results in comments - #62

Closed
gitluis wants to merge 2 commits into
masterfrom
docs-pr-layout-collapsible
Closed

gitluis wants to merge 2 commits into
masterfrom
docs-pr-layout-collapsible

Conversation

@gitluis

@gitluis gitluis commented Nov 5, 2026 •

Copy link
Copy Markdown
Owner

Summary

PR descriptions get long because reproduction steps, testing steps and test results sit next to the context. This adds a PR layout section to CLAUDE.md §0 so the description reads as context first, with the rest tucked away:

  • Visible: summary, cause (bug fixes), what changed, other context, "Not verified".
  • Collapsed next: "How to reproduce the bug" (bug fixes) and "How to test (step by step)", as <details> sections.
  • Last: "Please check before merging" (moved below the testing steps in f01279d, your request).
  • Test results in PR comments: one comment per test run, stamped with the commit, environment and date. A one-line status in the description links to the latest one.

This PR uses the layout itself.

What changed

Relation to #61

#61 (unmerged) names the sections ## Manual testing (step by step) and ## How to reproduce the bug. This PR is independent of it and doesn't edit its lines, so the only expected conflicts are the usual version lines. If both merge, the rules read together as: same content, but those sections become collapsed <details> blocks. I can reword #61 to match if you'd rather.

Open PRs reformatted

All open PRs were moved to this layout today, separately from this branch (description edits and comments only, no commits, no re-runs). Their earlier "How it was tested" text is now in a "Test results" comment on each PR.

Not verified

  • How the collapsed sections look in GitHub's mobile app.
Automated checks: earlier run, not re-run · 9246c1d

Moved unchanged from this PR's "Test results" comment on 2026-11-04; not re-run, so not in the new table format.

9246c1d · headless Chromium 153 (local server, no real folder) · 2026-11-04

  • ✅ Version lines: v1.10.8 in all five places (README ×2, index.html, CLAUDE.md ×2, Settings, CHANGELOG); no v1.10.5 left outside CHANGELOG history.
  • ✅ JavaScript syntax: node --check passes on every file in js/.
  • ✅ Product rules: no bank names in the added lines.
  • ✅ Boot: footer and Settings → General show v1.10.8.

Skipped or limited

  • The CDN libraries (PapaParse, Chart.js, Day.js, marked, DOMPurify) couldn't load in this sandbox, so the boot check covers the static shell and Settings only. This PR doesn't touch any code that uses them.
  • ✅ Description rendering (checked right after opening): GitHub renders the collapsed section with the numbered steps inside, and the status line links here.
Manual QA steps
  1. Files changed: only CHANGELOG.md, CLAUDE.md, README.md, index.html and js/views-settings.js.
  2. CLAUDE.md: open it on this branch. Under §0, a "PR layout" section sits between "What every PR includes" and "Stacked PRs".
  3. This PR's description: "How to test (step by step)" is collapsed at the end and opens when clicked. The steps inside show as a numbered list, not raw Markdown.
  4. Status line: the "results" link above jumps to the "Test results" comment on this PR.
  5. CHANGELOG.md: the top entry is ## [1.10.8] — 2026-11-04.
  6. Open the app: the sidebar footer and Settings → General show v1.10.8.

Please check before merging


Generated by Claude Code


Generated by Claude Code

gitluis and others added 2 commits November 5, 2026 00:05
CLAUDE.md §0 gets a "PR layout" section: the description shows context
(summary, cause, changes, not verified, please check), reproduction and
testing steps sit in collapsed <details> sections, and Claude's test
results go in one PR comment per run, linked from a status line.

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

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 puts test results in PR comments and collapses steps in <details>; the template keeps results in the description and bans <details>.

🤖 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.

2 participants