Skip to content

tasks.md Format

This specification defines the structured format for tasks.md in OpenLogos change proposals. The CLI depends on this format to accurately determine task status at each proposal stage.

tasks.md uses marked sections to organize tasks, where each section corresponds to a stage in the proposal workflow:

# 实现任务
## [delta] 规格变更
- [ ] Produce delta file to deltas/prd/1-product-requirements/ — update requirements
- [ ] Produce delta file to deltas/api/ — update API YAML
## [code] 代码实现
- [ ] Implement business logic in src/xxx
- [ ] Write corresponding tests
## [deploy] 部署执行
- [ ] Deploy to staging environment
- [ ] Verify deployment health
MarkerStagePurpose
[delta]Spec changesDelta file production tasks
[code]Code implementationBusiness code + test code tasks
[deploy]DeploymentDeployment execution tasks (optional)

Sections without markers are treated as general tasks and don’t affect proposal step detection.

Each task is a Markdown checkbox:

- [ ] Uncompleted task description
- [x] Completed task description

openlogos status reads tasks.md to determine the current proposal step:

ConditionProposal Step
[delta] section has unchecked itemsdelta-writing
All [delta] items checked (or no [delta] section)ready-to-merge
SPEC_MERGED exists + [code] has unchecked itemscoding
All [code] items checked (or no [code] section)ready-to-verify
VERIFY_PASS exists + [deploy] has unchecked itemsready-to-deploy
All [deploy] items checkeddeploy-done / ready-to-smoke

The presence of a [deploy] section signals that the proposal requires deployment:

  • Has [deploy] sectiondeployment_required: true (from tasks perspective)
  • No [deploy] section → falls back to proposal.md deployment impact declaration

If proposal.md says “no deployment needed” but tasks.md has a [deploy] section, openlogos status --format json reports a deployment_decision_conflict.

  1. Each task should be a single, actionable item
  2. Tasks should be specific enough to verify completion
  3. Delta tasks should reference the target directory
  4. Code tasks should reference the source file or module
  5. Deploy tasks should reference the target environment
# 实现任务
## [delta] 规格变更
- [x] Produce delta to deltas/prd/1-product-requirements/ — add S05 acceptance criteria
- [x] Produce delta to deltas/api/ — add GET /suggestions endpoint
- [x] Produce delta to deltas/test/ — add S05 test cases
## [code] 代码实现
- [x] Implement suggestion engine in src/lib/suggestions.ts
- [x] Add GET /suggestions route handler
- [x] Write UT-S05-01 through UT-S05-06 test code
- [x] Write ST-S05-01 through ST-S05-03 scenario tests
- [x] Add OpenLogos reporter to test runner
## [deploy] 部署执行
- [ ] Deploy to staging
- [ ] Verify /suggestions endpoint responds