[code-style-guide-bot] Update code-style.md with recurring review feedback (last 6 months)

[github-actions]

Window

Closed PRs in the last 6 months (cutoff: 2025-11-16), up to 2026-05-16. Up to 50 most-recently-closed Copilot-authored PRs were inspected.

Sources

Allow-listed reviewer comments from boxofyellow on the following PRs informed this update:

• Add optional display of FencedCodeBlock Info field #71 — [DataRow(...)] formatting, column alignment, test strictness
• Convert tests to use DataRow and reflection for better coverage and readability #72 — use reflection for enum-covering tests, reuse existing API instead of test-only helpers
• Add ValidatingFakeMarkdownDisplayer for asserting no warning conditions #85 — code coverage requirements, API visibility (internal vs public)
• Render blockquotes inside a Spectre.Console Panel #109 — file placement for non-trivial classes
• Render headings via Spectre.Console FigletText (IHeaderStyle, default H1) #113 — resource-based snapshot tests for renderer code, AssertCrossPlatStringMatch, fluent renderer chaining style, doc comment accuracy, README audience
• Render Markdig CustomContainer admonition blocks #132 — file placement (more than one-liner → own file)

Changes

• File and code placement: Added guidance that non-trivial classes (more than a one-liner) must live in their own file; one-liners may share a file. Sourced from repeated feedback on PRs Render blockquotes inside a Spectre.Console Panel #109 and Render Markdig CustomContainer admonition blocks #132.
• Test structure: Added rules for [DataRow(...)] usage, column alignment of DataRow values, reflection-based iteration over all enum values, test-validity strictness, and index-access guard asserts. Sourced from PRs Add optional display of FencedCodeBlock Info field #71, Convert tests to use DataRow and reflection for better coverage and readability #72.
• Preferred kinds of tests: Added preference for resource-based snapshot tests for renderer code (allowing visual inspection), AssertCrossPlatStringMatch for multi-line comparisons, and avoidance of integration-only coverage. Sourced from PR Render headings via Spectre.Console FigletText (IHeaderStyle, default H1) #113.
• Formatting & whitespace: Added the fluent chaining style used in ObjectRenderers. Sourced from PR Add optional display of FencedCodeBlock Info field #71.
• Reuse of existing patterns: Added guidance to use existing public API before adding test-only helpers, and to reuse shared test helpers. Sourced from PRs Convert tests to use DataRow and reflection for better coverage and readability #72, Render headings via Spectre.Console FigletText (IHeaderStyle, default H1) #113.
• References to in-repo guides: Added pointer to docs/adding_a_new_renderer.md. Sourced from PR docs: add guide for adding a new console renderer #103 (guide was added) and repeated reviewer references to it.
• Documentation comments: Added note to keep comments accurate during refactors. Sourced from PR Render headings via Spectre.Console FigletText (IHeaderStyle, default H1) #113.
• Audience of each document: Added distinction between docs/ (contributors/agents) and README.md (external consumers). Sourced from PR Render headings via Spectre.Console FigletText (IHeaderStyle, default H1) #113.

No entries were removed. The existing GitHub Actions section was preserved unchanged.

---

Filed automatically by the code-style-guide-bot agentic workflow.

Generated by Code Style Guide Bot · ● 7.1M · ◷