mirror of
https://github.com/YspCoder/clawgo.git
synced 2026-04-13 19:17:35 +08:00
Remove repo-root spec coding docs
This commit is contained in:
14
checklist.md
14
checklist.md
@@ -1,14 +0,0 @@
|
||||
# Verification Checklist (checklist.md)
|
||||
|
||||
- [x] Built-in `spec-coding` skill added
|
||||
- [x] Scaffold script added for `spec.md`, `tasks.md`, and `checklist.md`
|
||||
- [x] Shared markdown templates added under the skill
|
||||
- [x] Workspace policy updated to prefer spec-driven coding for non-trivial implementation work
|
||||
- [x] Agent context loads active project spec docs when present
|
||||
- [x] Missing project spec docs auto-initialize for coding tasks only
|
||||
- [x] `tasks.md` auto-tracks current coding turn progress
|
||||
- [x] Completed items can be reopened automatically on later debugging / retry work
|
||||
- [x] Context loading has tests for presence and truncation
|
||||
- [x] README documents the workflow
|
||||
- [x] Go tests pass for affected packages
|
||||
- [x] No known missing follow-up inside current scope
|
||||
36
spec.md
36
spec.md
@@ -1,36 +0,0 @@
|
||||
# Project Scope (spec.md)
|
||||
|
||||
## Overview
|
||||
- What is being built: spec-driven coding support for ClawGo.
|
||||
- Why this change is needed: coding tasks need a durable project scope, task plan, and verification gate instead of ad hoc reasoning scattered across chat turns.
|
||||
- Desired outcome: ClawGo should guide non-trivial coding work through `spec.md`, `tasks.md`, and `checklist.md`, expose that workflow in workspace policy, make active project docs visible to the agent during execution, and keep `tasks.md` progress moving automatically during coding turns.
|
||||
Completed tasks should also be reopenable when later debugging or regression work shows the task is not actually done.
|
||||
|
||||
## In Scope
|
||||
- Add a built-in `spec-coding` skill.
|
||||
- Provide a scaffold script for `spec.md`, `tasks.md`, and `checklist.md`.
|
||||
- Update workspace agent policy to prefer this workflow for non-trivial coding work.
|
||||
- Load current-project spec docs into agent context when present.
|
||||
- Document the workflow in the repo README.
|
||||
|
||||
## Out of Scope
|
||||
- A dedicated planner UI for spec documents.
|
||||
- Automatic task execution directly from `tasks.md`.
|
||||
- Complex state synchronization beyond markdown documents.
|
||||
|
||||
## Decisions
|
||||
- Use plain markdown files named exactly `spec.md`, `tasks.md`, and `checklist.md`.
|
||||
- Default location is the current project root, not the long-term workspace directory.
|
||||
- Expose the workflow primarily through workspace policy + built-in skill, not a new core planner service.
|
||||
- Load project docs into the system prompt with truncation to keep context bounded.
|
||||
- Only activate this workflow automatically for coding-oriented tasks, not for general chat or non-coding work.
|
||||
- Treat `workspace/skills/spec-coding/` as template storage only; project-specific docs must live in the target coding project.
|
||||
|
||||
## Tradeoffs
|
||||
- Loading project docs into prompt improves continuity but increases token usage when the files exist.
|
||||
- Root-level markdown files are simple and transparent, but they do add repo-visible artifacts.
|
||||
- A skill + prompt workflow is faster to adopt than introducing a new runtime subsystem, but it depends on agent discipline.
|
||||
|
||||
## Risks / Open Questions
|
||||
- `tasks.md` can grow large; prompt truncation mitigates this but may eventually need smarter summarization.
|
||||
- Some users may prefer a nested path such as `.clawgo/specs/`; current default stays simple unless explicitly requested.
|
||||
32
tasks.md
32
tasks.md
@@ -1,32 +0,0 @@
|
||||
# Task Breakdown (tasks.md)
|
||||
|
||||
## Workstreams
|
||||
|
||||
### 1. Workspace workflow
|
||||
- [x] Define how spec-driven coding should work in ClawGo.
|
||||
- [x] Update workspace policy to require `spec.md`, `tasks.md`, and `checklist.md` for non-trivial coding tasks.
|
||||
- [x] Add a built-in `spec-coding` skill.
|
||||
|
||||
### 2. Scaffolding
|
||||
- [x] Add a script that initializes the three markdown documents in the current project root.
|
||||
- [x] Keep scaffolding idempotent so existing docs are preserved.
|
||||
- [x] Reuse shared template files so shell and runtime initialization stay consistent.
|
||||
|
||||
### 3. Agent context
|
||||
- [x] Extend the context builder to surface current-project `spec.md`, `tasks.md`, and `checklist.md` when present.
|
||||
- [x] Add truncation to keep prompt growth bounded.
|
||||
- [x] Add tests for loading and truncation behavior.
|
||||
- [x] Restrict project planning docs to coding-oriented tasks only.
|
||||
- [x] Auto-initialize spec docs in the coding target project root when a coding task begins and files are missing.
|
||||
- [x] Auto-register the current coding request into `tasks.md`.
|
||||
- [x] Auto-mark the request complete and append a progress note when the turn succeeds.
|
||||
- [x] Reopen previously completed tasks when later repair/regression/debug work indicates they are not actually done.
|
||||
|
||||
### 4. Documentation
|
||||
- [x] Document the workflow in `README.md`.
|
||||
- [x] Apply the workflow to the current ClawGo enhancement itself by creating the three docs in the repo root.
|
||||
- [x] Clarify that skill files are templates and real project docs live in the coding target project.
|
||||
|
||||
## Progress Notes
|
||||
- The implementation stays lightweight on purpose: markdown files + built-in skill + policy + context loading.
|
||||
- No new planner service or database state was introduced in this iteration.
|
||||
Reference in New Issue
Block a user