Documentation
¶
Overview ¶
Package budget records a development experience measurement in the artifacts of the repository. See the SDD, section 3 and section 7, step 11.
Index ¶
Constants ¶
View Source
const ( // JSONFile holds the measurements that a machine reads. JSONFile = "verification.json" // MarkdownFile holds the table that a person reads. MarkdownFile = "verification.md" )
The files that the package writes.
View Source
const Dir = "artifacts"
Dir is the directory that holds the artifacts.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Measurement ¶
type Measurement struct {
// ID is the identifier of the requirement, such as DX-1.
ID string `json:"id"`
// Requirement states the requirement in one line.
Requirement string `json:"requirement"`
// Budget is the limit in seconds.
Budget float64 `json:"budget_seconds"`
// Elapsed is the measurement in seconds.
Elapsed float64 `json:"elapsed_seconds"`
// State is pass or fail.
State string `json:"state"`
// MeasuredAt is the time of the measurement.
MeasuredAt string `json:"measured_at"`
}
Measurement is one budget and its result.
Click to show internal directories.
Click to hide internal directories.