34 lines
1.7 KiB
Markdown
34 lines
1.7 KiB
Markdown
# PR#58: two diagrams show the workflow of a pull request and the inside of a review
|
|
|
|
> **WARNING:** This document describes only the change applied in this PR.
|
|
> It may already be outdated once the next PR is merged.
|
|
> Historic PR documentation is not maintained along with new PRs; treat it as a snapshot.
|
|
|
|
## The Problem
|
|
|
|
The flow diagram of the README shows what werkrevisor does inside one review.
|
|
It does not show the view of a pull request: who acts after each verdict, and how a new commit starts a new round.
|
|
It also does not show which files configure a review, and which service each step calls under which condition.
|
|
For talks and posts, e.g. on X, a Mermaid diagram is too small to read and needs scrolling.
|
|
|
|
## Non-Goals
|
|
|
|
- No change of the flow diagram of the README; both views stay.
|
|
- No change of the code or the configs.
|
|
|
|
## The Solution
|
|
|
|
- docs/werkrevisor-pr-workflow.svg and docs/werkrevisor-pr-workflow-dark.svg: one hand-drawn diagram in 16:9,
|
|
with lanes for the author, werkrevisor, a human reviewer and Gitea, in a light and a dark variant.
|
|
It shows the steps from the branch with its PR document to the merge, the consequence of each verdict,
|
|
the rounds of new commits, and three measured facts.
|
|
- docs/werkrevisor-review-inside.svg and its dark variant: the inside of one review, in the same 16:9 style;
|
|
the configuration files, the ten steps with the service each one calls and its condition, and the environment.
|
|
- README: both diagrams below the flow diagram; GitHub shows the dark variants in dark mode.
|
|
- docs/werkrevisor.werkbaum: a node for the diagrams, and a planned fix:
|
|
in this PR the economy model left out one statement, so the whole PR document check was skipped.
|
|
|
|
## Prerequisite PRs
|
|
|
|
- PR#57: werkrevisor 0.27.1, merged.
|