domain

package
v0.18.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 1, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source
const SchemaVersion = "v1"

Variables

This section is empty.

Functions

This section is empty.

Types

type DiscoveryRef

type DiscoveryRef struct {
	ID       string `yaml:"id" json:"id"`
	Title    string `yaml:"title" json:"title"`
	Document string `yaml:"document" json:"document"`
}

type Estimate

type Estimate struct {
	Value float64      `yaml:"value" json:"value"`
	Unit  EstimateUnit `yaml:"unit" json:"unit"`
}

type EstimateUnit

type EstimateUnit string
const (
	EstimatePoints EstimateUnit = "points"
	EstimateHours  EstimateUnit = "hours"
	EstimateDays   EstimateUnit = "days"
	EstimateWeeks  EstimateUnit = "weeks"
)

type ItemID

type ItemID string

type ItemKind

type ItemKind string
const (
	KindInitiative ItemKind = "initiative"
	KindFeature    ItemKind = "feature"
	KindTask       ItemKind = "task"
	KindDefect     ItemKind = "defect"
	KindResearch   ItemKind = "research"
)

type WorkBreakdown

type WorkBreakdown struct {
	SchemaVersion string       `yaml:"schema_version" json:"schema_version"`
	Discovery     DiscoveryRef `yaml:"discovery" json:"discovery"`
	Items         []WorkItem   `yaml:"items" json:"items"`
}

func (*WorkBreakdown) OrderedItems

func (w *WorkBreakdown) OrderedItems() ([]WorkItem, error)

func (*WorkBreakdown) Validate

func (w *WorkBreakdown) Validate() error

type WorkItem

type WorkItem struct {
	ID                 ItemID    `yaml:"id" json:"id"`
	Kind               ItemKind  `yaml:"kind" json:"kind"`
	Parent             ItemID    `yaml:"parent,omitempty" json:"parent,omitempty"`
	Title              string    `yaml:"title" json:"title"`
	Description        string    `yaml:"description" json:"description"`
	AcceptanceCriteria []string  `yaml:"acceptance_criteria,omitempty" json:"acceptance_criteria,omitempty"`
	DependsOn          []ItemID  `yaml:"depends_on,omitempty" json:"depends_on,omitempty"`
	Labels             []string  `yaml:"labels,omitempty" json:"labels,omitempty"`
	Estimate           *Estimate `yaml:"estimate,omitempty" json:"estimate,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL