common

package

v0.4.0 Latest Latest Go to latest Published: Jan 30, 2026 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/grokify/structured-requirements

Links

Open Source Insights

Documentation ¶

Overview ¶

Package common provides shared types used across PRD, MRD, and TRD documents.

Index ¶

func FormatPeopleMarkdown(people []Person) string
func FormatPersonMarkdown(p Person) string
type Approver
type Person

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FormatPeopleMarkdown ¶

func FormatPeopleMarkdown(people []Person) string

FormatPeopleMarkdown formats a slice of Person for markdown display. Returns a comma-separated list of formatted persons.

func FormatPersonMarkdown ¶

func FormatPersonMarkdown(p Person) string

FormatPersonMarkdown formats a Person for markdown display. Output formats:

"Name" (name only)
"[Name](mailto:email)" (name + email)
"Name (Role)" (name + role)
"[Name](mailto:email) (Role)" (all fields)

Types ¶

type Approver ¶

type Approver struct {
	Person
	ApprovedAt *time.Time `json:"approved_at,omitempty"`
	Approved   bool       `json:"approved"`
	Comments   string     `json:"comments,omitempty"`
}

Approver represents a person with approval authority.

type Person ¶

type Person struct {
	Name  string `json:"name"`
	Email string `json:"email,omitempty"`
	Role  string `json:"role,omitempty"`
}

Person represents an individual contributor.

Source Files ¶

View all Source files

person.go

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