docs: add dogfood lessons from NRS-4373 review - #2
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the peer QA review documentation by introducing a new anti-pattern against fabricated or reformatted output, emphasizing the importance of literal raw terminal output for auditability. It also refines the functional verification template and adds a warning about shell-stripping of "{code}" tags when posting comments via CLI, suggesting the use of single-quoted heredocs as a solution. I have no feedback to provide.
|
|
You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool. What Enabling Code Scanning Means:
For more information about GitHub Code Scanning, check out the documentation. |
- anti-patterns: reviewer anti-pattern for fabricated/reformatted output in
{code} blocks (paste literal output, not a tidy summary)
- comment-template: sanity-scan item for a required TL;DR comment on
non-clean verdicts; functional-verification placeholder now asks for
literal raw output (not reformatted/summarised)
Signed-off-by: mikhail.sarnov <mikhail.sarnov@netresearch.de>
e097f54 to
32c84e1
Compare
|
3 participants
Dogfood lessons from the NRS-4373 review, rebased onto current main.
Changes
{code}blocks. Paste literal terminal output, not a tidy hand-written summary (even an accurate one can't be independently audited).Rebase note
The branch's original
{code}-in-prose escaping item was dropped: current main already covers it (sanity-scan item 7, "Unescaped block-markup tags in prose"). The self-correcting commits were squashed into one.