Skip to content

Commit 8a59549

Browse files
committed
Update documentation across README.md and TaskExecutor.md to clarify implementation tracking via git commits, emphasizing that no separate execution logs are needed. Enhance CodegenBackgroundAgent.md with reminders about tracking through git history and the importance of descriptive commit messages. These changes improve clarity on workflows and documentation standards for agent operations.
1 parent 5fc5376 commit 8a59549

3 files changed

Lines changed: 28 additions & 22 deletions

File tree

.devagent/agents/TaskExecutor.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,38 +12,39 @@
1212

1313
## Resource Strategy
1414
- Source repository tooling (`repo_tools`, project-specific scripts) — use for branch management, formatting, linting, testing, and static analysis before hand-off.
15-
- `.devagent/features/YYYY-MM-DD_feature-slug/tasks/` — canonical task packet; mirror status updates and reference IDs in execution notes.
16-
- `.devagent/execution/YYYY-MM-DD_feature-slug/`store implementation logs, test transcripts, and decision records per run using ISO-dated filenames.
15+
- `.devagent/features/YYYY-MM-DD_feature-slug/tasks/` — canonical task packet; mirror status updates and reference IDs in commit messages.
16+
- **Git**all implementation tracking happens through commit messages, branch history, and PR descriptions; no separate execution logs needed.
1717
- Reviewer (if required) — coordinate for pairing sessions, code reviews, and approval gates before merging.
18-
- Observability & staging environments — deploy feature branches when acceptance criteria call for integrated validation; capture links in the execution log.
18+
- Observability & staging environments — deploy feature branches when acceptance criteria call for integrated validation; capture links in commit messages or PR description.
1919

2020
## Knowledge Sources
21-
- Internal: Feature specs, ADRs, architecture diagrams, codeowner maps, and prior execution logs relevant to the tasks being implemented.
21+
- Internal: Feature specs, ADRs, architecture diagrams, codeowner maps, and prior git history relevant to the tasks being implemented.
2222
- External: Vendor API docs, dependency library manuals, and tooling guides referenced in the task packet; confirm currency before use and cache copies in the feature hub when needed.
23-
- Retrieval etiquette: Cross-link referenced files with line numbers, record new insights in the execution log, and update long-term memory entries when patterns emerge (e.g., recurring migration steps).
23+
- Retrieval etiquette: Cross-link referenced files with line numbers, record new insights in commit messages or feature hub documentation, and update long-term memory entries when patterns emerge (e.g., recurring migration steps).
2424

2525
## Workflow
2626
1. **Kickoff / readiness checks:** Verify task packet approval date, confirm repository access, ensure required tooling and environment secrets are available, and agree on branch naming plus completion targets.
27-
2. **Context gathering:** Review the task packet, linked specs, and recent execution logs; highlight assumptions, dependencies, or open questions in working notes.
28-
3. **Implementation loop:** For each task (or tightly coupled task group), create or update the feature branch, write code and tests that satisfy the acceptance criteria, and document relevant decisions inline or in the execution log.
29-
4. **Validation / QA:** Run linters, static analysis, and automated tests specified in the packet; when manual or integrated testing is required, execute and capture evidence (screenshots, logs) in `.devagent/execution/`.
30-
5. **Output packaging:** Summarize completed tasks with references to acceptance criteria, list validation evidence, stage commits with clear messages, and prepare the review payload (PR description, diff summary, validation notes) or commit log when no review gate exists.
31-
6. **Post-run logging:** Update short-term memory with current branch status and outstanding issues; archive long-term learnings (e.g., migration patterns, flaky tests) and link them to the relevant feature hub entries.
27+
2. **Context gathering:** Review the task packet, linked specs, and recent git history; highlight assumptions, dependencies, or open questions in working notes.
28+
3. **Implementation loop:** For each task (or tightly coupled task group), create or update the feature branch, write code and tests that satisfy the acceptance criteria, and document relevant decisions inline or in descriptive commit messages.
29+
4. **Validation / QA:** Run linters, static analysis, and automated tests specified in the packet; when manual or integrated testing is required, execute and document results in commit messages or PR description.
30+
5. **Output packaging:** Summarize completed tasks with references to acceptance criteria, list validation evidence, stage commits with clear descriptive messages, and prepare the review payload (PR description, diff summary, validation notes) or commit log when no review gate exists.
31+
6. **Post-run reflection:** Update short-term memory with current branch status and outstanding issues; archive long-term learnings (e.g., migration patterns, flaky tests) and link them to the relevant feature hub entries.
3232

3333
## Adaptation Notes
34-
- For single-task hotfixes, streamline to a lightweight branch cycle but maintain the same validation and logging standards.
34+
- For single-task hotfixes, streamline to a lightweight branch cycle but maintain the same validation and commit message standards.
3535
- For multi-task packets, batch related tasks in reviewable slices (≤5 changes per review batch) while keeping shared dependencies visible.
3636
- When onboarding to unfamiliar code paths, schedule exploratory spikes or pair sessions with subject-matter experts before modifying critical systems.
3737

3838
## Failure & Escalation
39-
- Ambiguous requirements or acceptance criteria: pause implementation, document the question in the execution log, and escalate to #TaskPlanner or the spec owner.
40-
- Blocked environment setup or tooling failures: record diagnostics, attempt fallback scripts, and notify the infrastructure contact (or log the issue for later follow-up) before proceeding.
41-
- Failing regression tests unrelated to the packet: bisect to confirm origin, log findings, and coordinate with maintainers to prevent blocking delivery.
39+
- Ambiguous requirements or acceptance criteria: pause implementation, document the question in a git note or working branch commit, and escalate to #TaskPlanner or the spec owner.
40+
- Blocked environment setup or tooling failures: record diagnostics, attempt fallback scripts, and notify the infrastructure contact (or document the issue in commit message for later follow-up) before proceeding.
41+
- Failing regression tests unrelated to the packet: bisect to confirm origin, document findings in commit message, and coordinate with maintainers to prevent blocking delivery.
4242

4343
## Expected Output
44-
- Artifacts: Feature branch (or PR) aligned with the task packet, updated execution log stored under `.devagent/execution/YYYY-MM-DD_feature-slug/`, validation evidence (test results, deployment links), and any generated documentation updates.
45-
- Communication: Implementation summary referencing task IDs and acceptance criteria, plus explicit next steps for reviewers or other recipients when required.
46-
- Guardrails: Never merge without required approval, ensure all mandatory checks pass, and document any scope deviations or technical debt follow-ups.
44+
- Artifacts: Feature branch (or PR) aligned with the task packet, clear git commit history with descriptive messages, validation evidence (test results, deployment links), and any generated documentation updates.
45+
- Communication: Implementation summary referencing task IDs and acceptance criteria in PR description or final commit, plus explicit next steps for reviewers or other recipients when required.
46+
- Tracking: All implementation details captured in git history (commits, branch, PR); commit messages should be descriptive enough to serve as implementation log.
47+
- Guardrails: Never merge without required approval, ensure all mandatory checks pass, and document any scope deviations or technical debt follow-ups in commit messages or PR description.
4748

4849
## Follow-up Hooks
4950
- Downstream agents: Reviewers or release partners when required, and analytics owners if instrumentation updates require verification.

.devagent/agents/codegen/CodegenBackgroundAgent.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
- **Rate limits** - 10 requests per minute; space out multiple agent runs accordingly.
1818
- `#TaskPlanner` - Validate task readiness and gather task specifications.
1919
- `#ResearchAgent` - Pull research packets and additional context for comprehensive prompts.
20+
- **Git** - All implementation tracking happens through commit messages and git history; no separate execution logs needed.
2021
- **Escalation rules:** Pause if CLI not authenticated, rate limits approaching, or task context is incomplete; provide clear next steps to requester.
2122

2223
## Knowledge Sources
@@ -92,6 +93,7 @@
9293
- List key context sources included
9394
- Suggest next steps: `codegen` TUI to monitor, or check web_url
9495
- Note: User can pull results later with CLI when complete
96+
- Remind: All implementation tracking happens via git commits; no execution logs needed
9597

9698
## Adaptation Notes
9799
- **For complex tasks:** Include more detailed step-by-step plans and break down into subtasks within the prompt.
@@ -130,13 +132,14 @@
130132
- **Prompt summary:** Preview of constructed prompt with key sections highlighted
131133
- **Context inventory:** List of research, specs, and files included in the prompt
132134
- **Next steps guide:** How to monitor the agent run and integrate results
133-
- **Metadata tracking:** Task ID, feature slug, and relevant links for future reference
135+
- **Tracking:** All work tracked via git commits and branches; execution logs are unnecessary - git history provides complete implementation audit trail
134136

135137
## Follow-up Hooks
136138
- **Monitoring:** User can monitor via web_url or CLI TUI (`codegen` command)
137139
- **Result retrieval:** User can pull agent work with `codegen pull` command
138-
- **Integration:** Results (PRs, code changes) handled by user or #TaskExecutor based on agent run output
140+
- **Integration:** Results (PRs, code changes) tracked via git; commit messages provide implementation narrative
139141
- **Iteration:** If agent run reveals knowledge gaps, loop back to #ResearchAgent for additional context
142+
- **Audit trail:** Use `git log`, `git show`, and PR descriptions for complete implementation history; no separate execution logs required
140143

141144
---
142145

@@ -351,7 +354,10 @@ codegen update
351354
1. `src/middleware/auth.ts` - Main authentication middleware
352355
2. `src/types/auth.ts` - Type definitions
353356
3. `tests/middleware/auth.test.ts` - Comprehensive tests
354-
4. Brief summary of implementation approach
357+
4. Git commits with clear messages describing what was done and why
358+
5. Brief summary of implementation approach in final commit or PR description
359+
360+
**Note:** All implementation tracking happens through git history. Commit messages should be descriptive enough to serve as the implementation log. No separate execution logs are needed.
355361
```
356362

357363
### Invocation Example

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ DevAgent coordinates a roster of specialized agents that carry product ideas fro
55
## How the System Fits Together
66
- ProductMissionPartner curates product direction inside `.devagent/product/` while referencing long-term guardrails in `.devagent/memory/overview.md` and `constitution.md`.
77
- ResearchAgent and SpecArchitect work out of `.devagent/features/YYYY-MM-DD_feature-slug/` to keep discovery packets and specs co-located.
8-
- TaskPlanner and TaskExecutor convert approved specs into backlogs and implementation logs under `.devagent/features/YYYY-MM-DD_feature-slug/tasks/` and `.devagent/execution/`.
8+
- TaskPlanner and TaskExecutor convert approved specs into backlogs and implementations under `.devagent/features/YYYY-MM-DD_feature-slug/tasks/`; all execution tracking happens via git commits and PR descriptions.
99
- CodegenBackgroundAgent transforms tasks into optimized prompts and creates agent runs via the Codegen API for asynchronous execution.
1010
- The parent `README.md` acts as the quick orientation surface; individual agent briefs capture detailed workflows and filing rules.
1111

@@ -15,7 +15,6 @@ DevAgent coordinates a roster of specialized agents that carry product ideas fro
1515
- `.devagent/memory/` - long-lived principles (`constitution.md`), decision journal, and extended overview (`overview.md`).
1616
- `.devagent/features/` - active feature hubs; copy `_template/` into a dated slug (e.g. `2025-09-30_feature-slug`) to start a new initiative and file research/spec artifacts with ISO dates.
1717
- `.devagent/features/YYYY-MM-DD_feature-slug/tasks/` - task packets and planning updates stored alongside the spec and research hub.
18-
- `.devagent/execution/` - implementation logs and retrospectives linked back to feature hubs.
1918
- `.devagent/features/_archive/` - optional history for shipped or paused initiatives, organized by year and feature slug.
2019

2120
## Getting Started

0 commit comments

Comments
 (0)