Index of every page on this site: llms.txt
All skills
onmax avatar

/review-document

@aecfada
by Maxonmax/comark-ui43 stars
3
Run it yourself

Turns a review's findings into one short Markdown document a reader can act on, with the verdict first and each finding ranked, located, backed by evidence, and paired with its fix. Use when writing up a code review, a design or QA review, or an audit, where the reader must decide what to do about what you found.

Use this Skill: https://skilld.dev/gh/onmax/comark-ui/review-document

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

referencesblocks.md

≈560 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Blocks for a review document

These blocks come with comark-ui, or alone with comark-github, comark-tests, comark-diff, and comark-code. The comark-ui skill (vp dlx skills add onmax/comark-ui) documents every block in full.

The verdict: a callout

> [!CAUTION] Request changes
> One blocking finding: after a large avatar loads, every smaller one shows the large image.

The text after the marker is the title. [!CAUTION] fits request changes or blocked, [!WARNING] approve with changes, [!TIP] approve, and [!NOTE] context the reader needs before the findings. Any other marker stays a plain quote and is reported.

A test run: ::tests

Paste the JUnit XML the runner wrote, unedited, so the counts are the run's own:

::tests{title="pnpm test src/avatars"}
```xml
<testsuite name="cache.test.ts" time="0.18">
  <testcase classname="cache.test.ts" name="returns a cached avatar"/>
  <testcase classname="cache.test.ts" name="returns a 32px avatar after a 512px one">
    <failure message="expected 512 to be 32">AssertionError: expected 512 to be 32</failure>
  </testcase>
</testsuite>
```
::

It shows the passed, failed, and skipped counts and each failure's message and stack. Most runners write the report with a flag: vitest run --reporter=junit --outputFile=junit.xml, pytest --junitxml=junit.xml, jest --reporters=jest-junit. For a command that isn't a test run, paste its output in a txt or sh fence instead.

The lines that cause it: a fence with mark

```ts [src/avatars/cache.ts] mark={1}
const cache = new Map<string, Blob>();
```

mark={1} highlights the block's first line; ranges look like {3-4} or {1, 3-4}. Copy a few lines from the file, the ones your text names.

The fix: ::diff

::diff{line=18 label="Fix"}
```ts [src/avatars/cache.ts]
const key = user.id;
```
```ts
const key = `${user.id}:${size}`;
```
::

Two fenced blocks, before then after, starting at the file's line line. One file per diff, a few lines each.

A long log: <details>

<details>
<summary>Full test output</summary>

…

</details>

Fold away anything the reader may skip, such as a full log under the failure that matters.

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts6d3 checks · Risk SAFE
  • Gen Agent Trust Hub8d

    This skill facilitates the creation of structured review documents and utilizes vendor-provided tools for linting. It is generally secure but possesses an indirect prompt injection surface from processed review findings.

  • Socket6d

    No alerts

  • Snyk8d

    Risk: LOW · No issues

Signed by skilld at aecfada. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 2 weeks ago

README badge

README badge for onmax/comark-ui/review-document