Skip to content
Docs detent.build guides detent.build guide
project-contracts.md

Provenance: generated from site-authored sources with github.com/gopherguides/hype v0.8.0.

Project contracts

This site is orchestrated from two checked-in contracts: the project configuration and the agent workflow.

Project configuration

The opening section of the live project configuration identifies the tracker, status source, and repository used for this site.

schema: 1
# Keep machine-specific config in detent.local.yaml and local agent direction in WORKFLOW.local.md.
tracker:
  kind: github
  github_status_source: label
  repository: digitaldrywood/detent.build
  status_label_prefix: "detent:"
  http_max_idle_conns: 100
  http_max_idle_conns_per_host: 32
  http_idle_conn_timeout_ms: 90000
  github_graphql_warn_remaining: 500
  github_graphql_min_remaining_reserve: 1000
  github_rest_min_remaining_reserve: 1000
  github_rest_fanout_max_requests: 80
  github_rest_debug_logging: false
  auto_provision: true
  active_states:
    - Todo
    - In Progress
    - Rework
    - Merging
  observed_states:
    - Backlog
    - Human Review
    - Blocked
  terminal_states:
    - Done
    - Cancelled
  state_map:
    Cancelled: Done
  priority_map:
    Urgent: 1
    High: 2
    Medium: 3
    Low: 4
    No priority: null
  authorization:
    author_in:
      - corylanou
      - loganlanou
      - jarvislanou
  dependency_auto_unblock:
    enabled: true
    source_states:
      - Blocked

source: detent.yaml:project-config


Agent workflow

The site-owned example below shows the durable Workpad signal and validation gate expected from an agent workflow.

You are working on {{ issue.identifier }}: {{ issue.title }}.
Current Detent status: {{ issue.state }}.

Keep changes scoped to the issue and maintain one persistent
`## Codex Workpad` issue comment with the plan and validation evidence.

## Validation

Run the project validation gate before declaring completion:

~~~sh
make check && CGO_ENABLED=0 go build -o /dev/null ./cmd/server
~~~

## Status signal

Use `in_progress` while implementation or validation is active:

~~~detent-status
schema: 1
status: in_progress
blockers: []
human_action: null
~~~

Use `complete` only after the pull request is ready, current-head validation
is green, and no actionable review comments remain:

~~~detent-status
schema: 1
status: complete
blockers: []
human_action: null
~~~

source: partials/examples/WORKFLOW.md