feat: finalize AI logging framework and workflow
- align instructions, workflow rules, and task template with three-level logging - extend ai-task generation to support execution-log requirements - update worklog, prompt log, and execution log for the finalized framework - validate the framework with generator and project quality checks
This commit is contained in:
@@ -67,6 +67,7 @@ This repository maintains an AI-assisted development log.
|
||||
Files:
|
||||
- `docs/ai-worklog.md`
|
||||
- `docs/ai-prompts.md`
|
||||
- `docs/ai-execution-log.md`
|
||||
|
||||
Rules:
|
||||
1. After every significant `plan` or `build` task, append a concise worklog entry to `docs/ai-worklog.md`.
|
||||
@@ -98,19 +99,25 @@ This applies to:
|
||||
Required files:
|
||||
- `docs/ai-worklog.md`
|
||||
- `docs/ai-prompts.md`
|
||||
- `docs/ai-execution-log.md`
|
||||
|
||||
Mandatory rules:
|
||||
1. After every significant `plan` task, append a concise entry to `docs/ai-worklog.md`.
|
||||
2. After every significant `build` task, append a concise entry to `docs/ai-worklog.md`.
|
||||
3. If the task was driven by a meaningful prompt, also append an entry to `docs/ai-prompts.md`.
|
||||
4. Logging is part of the task itself and must not be skipped.
|
||||
5. The task is not complete until the logs are updated.
|
||||
6. Logs must always be written **before creating a commit**.
|
||||
7. The agent must ensure that the following files are updated and staged before any commit:
|
||||
4. The agent must append a full execution entry to `docs/ai-execution-log.md` including:
|
||||
- the full prompt provided to the agent
|
||||
- the agent todo list or execution plan
|
||||
- the final execution report produced by the agent
|
||||
5. Logging is part of the task itself and must not be skipped.
|
||||
6. The task is not complete until the logs are updated.
|
||||
7. Logs must always be written **before creating a commit**.
|
||||
8. The agent must ensure that the following files are updated and staged before any commit:
|
||||
- `docs/ai-worklog.md`
|
||||
- `docs/ai-prompts.md`
|
||||
8. If a commit is created without the corresponding log entries, the task is considered incomplete and must be corrected.
|
||||
9. Log entries must be part of the same commit whenever possible to maintain traceability between the code change and the AI task that produced it.
|
||||
- `docs/ai-execution-log.md`
|
||||
9. If a commit is created without the corresponding log entries, the task is considered incomplete and must be corrected.
|
||||
10. Log entries must be part of the same commit whenever possible to maintain traceability between the code change and the AI task that produced it.
|
||||
|
||||
Each worklog entry must include:
|
||||
- date
|
||||
@@ -127,6 +134,7 @@ Validation logging rule:
|
||||
- The value `validation: not run` may only be used if no validation commands were executed.
|
||||
- The worklog entry must reflect the actual commands run during the task.
|
||||
|
||||
|
||||
Each prompt log entry must include:
|
||||
- date
|
||||
- task type (`plan` or `build`)
|
||||
@@ -140,6 +148,14 @@ Rules:
|
||||
- Keep entries chronological.
|
||||
- Even small but meaningful tasks must be logged.
|
||||
|
||||
Execution log entries must include:
|
||||
- date
|
||||
- task ID
|
||||
- task type (`plan` or `build`)
|
||||
- full prompt text
|
||||
- agent todos
|
||||
- execution report
|
||||
|
||||
## Standard AI Log Entry Format
|
||||
|
||||
To ensure consistency and readability of long AI-assisted development histories, all log entries must follow a standardized block format.
|
||||
|
||||
Reference in New Issue
Block a user