Esc

A pull request description

Write a pull request's description in Markdown, with its status on top and its evidence under it, and every block checked before it's posted.

Playground
Status
Ready for review
Author
onmax
Tags
mapperformance

The pigeon map counts each plaza in a worker, so the page scrolls while it counts.

Metric Before After Change
JavaScript 412 kB 388 kB ↓ 5.8%
Largest paint 2.4 s 1.9 s ↓ 20.8%

Pigeon map tests3 passed1.8 s

The worker starts on loadon the first scrollMost visitors never scroll the map.

A reviewer reads from the top, so each block answers the next question they'd ask:

  1. The frontmatter holds what a script reads too: the status, the pull request, the author, and tags. comark-properties shows them in a box at the top, and your tooling reads the same keys.
  2. A sentence says what changed. An icon in front of it, from comark-icon, sets it apart from the evidence.
  3. A ::stats table from comark-metrics shows the numbers that moved, each with its change and whether it got better.
  4. A ::tests block from comark-tests reads the JUnit report your test runner wrote, so the counts can't drift from the run.
  5. A suggestion still open goes in CriticMarkup, from comark-critic, with the reason as a comment, so the reviewer sees what you'd change and why.

Register the plugins in one renderer, as Renderers shows. With a report on disk, point ::tests{src} at it instead of pasting it in a fence, as comark-tests shows.

Run comark-linter on the file before you post it. A delta that can't be read, a report that isn't JUnit, and a suggestion left open each name their block and say how to fix it.