Documentation
¶
Overview ¶
Package findings reads a review's findings file, the shape steps/review.md fixes: a header of `key: value` lines, a `## Categories` list with a count per category, and a block per finding under `## Prior round` and `## Findings`, each a `### <id> <title>` heading with `key: value` lines, the `verdict:` and `reason:` that resolve appends among them.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrNoHeader = errors.New("findings: no header")
ErrNoHeader is a file without the header's task and round.
Functions ¶
Types ¶
type File ¶
type File struct {
Task string
Round string
Reviewed string // the sha, plus ` dirty` when the tree differed
Reviewer string
Verdict string // clean or findings
Categories map[string]int
Findings []Finding
}
File is one findings file.
type Finding ¶
type Finding struct {
ID string
Title string
Category string
Prior bool
Status string // prior round only: fixed, still open, ...
Verdict string // as written, attachments included: `skip +reply`
Reason string
}
Finding is one block. Prior-round blocks carry their round-one id and the status the second review gave them.
Source Files
Click to show internal directories.
Click to hide internal directories.