liran-funaro / sphinx-markdown-builder / 42026936451
100%

DEFAULT BRANCH: main
Ran
Jobs 4
Files 5
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 97.439%. Remained the same
42026936451

push

github

web-flow 
Add maintainer review conventions to the pr-review skill (#95)

This adds the review feedback that keeps coming up in this repo to the
`pr-review` skill. Agents reviewing a PR check it against these rules,
and contributors' agents can follow them before opening one.

## How I found the rules

I read every PR in the repository (41 in total) and collected each
review, inline comment and PR comment by @liran-funaro. That came to 45
reviews, 45 inline comments and 16 PR comments. I then grouped them by
the kind of correction.

The most common request was to replace white-box unit tests with
fixtures in `tests/source` and expected output in `tests/expected` (#61,
#63, #71, #72, #79, #81). The next most common were:

- use `PREDEFINED_ELEMENTS` instead of empty handlers (#16, #93)
- keep node-specific state in contexts (#53, #68)
- inline single-use helpers (#63, #71)
- add comments that describe the doctree (#58, #71)
- keep each PR to one topic (#49, #63)

## Changes

The new `.agents/skills/pr-review/RULES.md` holds 14 rules in five
groups: testing, translator architecture, code style, scope and design,
and project hygiene. Each rule states the convention and the reason for
it. It then shows a "Not this" example of a change to flag and a "This"
example of the form to ask for.

In `.agents/skills/pr-review/SKILL.md` I made four changes:

- The `description` now says when the skill should trigger: reviewing a
pull request, or checking your own changes before opening one. Agents
use the description to decide when to load the skill, so a summary of
what the skill does doesn't help them.
- A new step tells the agent to check the diff against every rule in
`RULES.md`. The step is done when the agent has tied each rule to
specific hunks or marked it as not touched by the diff.
- The report must name the rule behind each finding and show the "This"
form of the fix.
- I removed the old steps about preferring fixtures and leaving version
numbers alone. Rules 1 and... (continued)

761 of 781 relevant lines covered (97.44%)

3.9 hits per line

Jobs
ID Job ID Ran Files Coverage
1 python-3.12 - 42026936451.1 5
97.44
GitHub Action Run
2 python-3.13 - 42026936451.2 5
97.44
GitHub Action Run
3 python-3.14 - 42026936451.3 5
97.44
GitHub Action Run
4 python-3.11 - 42026936451.4 5
97.44
GitHub Action Run
Source Files on build 42026936451