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.
- 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.
---
status: Ready for review
pr: https://github.com/onmax/comark-ui/pull/111
author: onmax
tags: [map, performance]
---
:icon{name="lucide:rocket"} The pigeon map counts each plaza in a worker, so the page scrolls while it counts.
::stats{better="lower"}
| Metric | Before | After |
| --- | --- | --- |
| JavaScript | 412 kB | 388 kB |
| Largest paint | 2.4 s | 1.9 s |
::
::tests{title="Pigeon map tests"}
```xml
<testsuite name="map.test.ts" time="1.8">
<testcase name="counts each plaza"/>
<testcase name="keeps scrolling while it counts"/>
<testcase name="shows a plaza with no pigeons as zero"/>
</testsuite>
```
::
:icon{name="lucide:message-circle"} The worker starts {~~on load~>on the first scroll~~}{>>Most visitors never scroll the map.<<}The order
Section titled "The order"A reviewer reads from the top, so each block answers the next question they'd ask:
- 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.
- A sentence says what changed. An icon in front of it, from comark-icon, sets it apart from the evidence.
- A
::statstable from comark-metrics shows the numbers that moved, each with its change and whether it got better. - A
::testsblock from comark-tests reads the JUnit report your test runner wrote, so the counts can't drift from the run. - 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.
Check it
Section titled "Check it"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.