Skip to content

docs(review): make review comments readable and require regression tests - #27

Merged
vitormattos merged 1 commit into
mainfrom
fix/review-readable-comments-regression-coverage
Nov 9, 2026
Merged

vitormattos merged 1 commit into
mainfrom
fix/review-readable-comments-regression-coverage

Conversation

@vitormattos

Copy link
Copy Markdown
Member

Summary

  • Present proposed GitHub comments as wrapping, copy-ready prose rather than fenced markdown blocks that force horizontal scrolling.
  • Keep short GitHub suggestion code fences for verified replacement code, with the explanation readable outside the fence.
  • Ask for a focused regression test for confirmed behavioral bugs whenever feasible, including a reachable scenario, an observable expectation, and a valid control.
  • For suspected bugs, request a discriminating test before demanding a code change; avoid artificial tests for purely architectural concerns.
  • Update the review presentation reference and evaluation cases for readability, bug-report evidence, and architectural exceptions.

Motivation

A review of LibreSign/libresign#9375 exposed poor readability of long GitHub-ready comments when shown inside fenced Markdown blocks. The same feedback identified a need for review comments about bugs to require regression coverage rather than merely describing a potential fix.

Validation

  • Signed commit verified by GitHub with matching author and DCO trailer.
  • Compared against the pinned main revision: only the intended three Markdown files changed.
  • Git patch application validated during commit creation.
  • The repository's Python unit suite and REUSE lint have not been executed locally; CI should validate those checks on this PR.

No changes were made to LibreSign/libresign#9375 by this PR.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
vitormattos merged commit ecf373c into main Nov 9, 2026
2 checks passed
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