claude-code
2c41b912f4
werkator build succeeded after 00:05
werkrevisor 0.9.0: deterministic writing rules for changed docs, and jev-eval with the config layers of the review. - Changed Markdown lines are checked against the AGENTS.md writing style: one sentence per line, line length, sentences per paragraph. Violations give ORANGE; the model still runs. - The unreliable Jev question about the writing rules is removed. - `tools/jev-eval` reads defaults < host < repository config. Details: the PR document under `docs/prs/`. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Reviewed-on: #6 Co-authored-by: claude-code <claude-code@javagil.de>
1.8 KiB
1.8 KiB
Pull-Request Documentation in docs/prs
Every pull request (PR) of werkrevisor has one document in this directory. It documents the change of that PR at that time; later PRs do not maintain it.
Workflow
- A new branch gets its PR document right away, and the branch is pushed.
- A PR is opened with the prefix
WIP:in its title; the file name gets the real PR number. - The PR keeps the
WIP:prefix until its author considers it ready for review. - Removing the prefix starts the review by werkrevisor itself, through Werkator.
Naming Convention
YYYY-MM-DD-PR#999-short-description-of-pr.md
- Date of the PR in the format
YYYY-MM-DD, -PR#and the number of the pull request in Gitea,- a short description with dashes between the words,
.md.
Guidelines
- Markdown, in English.
- One sentence per line, to keep diffs readable.
- Explain the why; keep it short.
- Mark references to non-public tools as "Hostsharing-internal".
Open Questions Block the Review
werkrevisor checks the section "Open Questions" of every PR document a PR adds or changes.
An item with [ ], or an item or paragraph without a checkbox, makes the review RED, before any model call.
Mark an answered question with [x]; put the answer on an indented continuation line of the item.
The whole item counts as checked, not its source lines.
Structure
The main (##) sections appear in this order; omit the ones that do not apply:
- Related Links (optional)
- The Problem (required)
- Non-Goals (required)
- The Scenarios (required for features)
- The Solution (required)
- Open Questions (optional)
- Additional Changes (optional)
- Prerequisite PRs (optional)
- Follow-up PRs (optional)
- Attachments (optional)
For details, see the template.