chore(logs): split agent change log outputs
This commit is contained in:
@@ -1,55 +1,63 @@
|
||||
---
|
||||
name: agent-change-log
|
||||
description: Use when working in X-Financial after bug fixes, new features, refactors, behavior changes, documentation edits, config edits, concurrent-agent Git commits, or any codebase modification that should leave an incremental human-readable work log.
|
||||
description: Use when working in X-Financial after bug fixes that need a split dev log, when maintaining document/development/YYYY-MM-DD/dev-logs/bugs, or when generating the daily 17:00 combined work-logs.med from same-day feature docs and bug logs.
|
||||
---
|
||||
|
||||
# Agent Change Log
|
||||
|
||||
## Overview
|
||||
|
||||
This skill keeps a living, incremental work log for X-Financial. After each meaningful modification batch, write down what changed locally, what other agents already committed upstream, what was operated on, what remains uncertain, and what should happen next.
|
||||
This skill keeps split development logs for X-Financial. Bug fixes are recorded under the same-day `dev-logs/bugs` folder. Daily summaries combine same-day feature documents and bug records into one `work-logs.med`.
|
||||
|
||||
The log should sound like a careful teammate writing for tomorrow's teammate: concrete, warm, and honest.
|
||||
|
||||
## When To Use
|
||||
|
||||
- After fixing a bug, adding a feature, refactoring, changing behavior, editing documentation, or changing config.
|
||||
- Before the final response for any turn that changed files.
|
||||
- After fixing a bug.
|
||||
- When a post-commit hook detects a bug-like commit.
|
||||
- At the daily 17:00 summary pass.
|
||||
- Before updating the log in a branch where other agents may have pushed commits.
|
||||
- After verification, so the entry can include what was actually checked.
|
||||
- When a failed attempt changed files, generated artifacts, or revealed a risk worth preserving.
|
||||
|
||||
Do not use for read-only investigation with no file changes unless the user explicitly asks for a record.
|
||||
Do not create legacy `document/work-log/YYYY-MM-DD.md` entries for new work.
|
||||
|
||||
## Log Location
|
||||
|
||||
Use one file per day:
|
||||
Use the same date root as development documents:
|
||||
|
||||
```text
|
||||
document/work-log/YYYY-MM-DD.md
|
||||
document/development/YYYY-MM-DD/
|
||||
├── feature/<feature-point>/CONCEPT.md + TODO.md
|
||||
├── dev-logs/bugs/<bug-slug>.md
|
||||
└── work-logs.med
|
||||
```
|
||||
|
||||
If the file does not exist, create it. If it exists, incrementally update it. Never replace the whole file just to add a new entry.
|
||||
If the date folder exists, reuse it. If not, create it.
|
||||
|
||||
## Required Structure
|
||||
## Bug Log Structure
|
||||
|
||||
Each daily file must use these sections in this order:
|
||||
For bug fixes, create or update one file per bug:
|
||||
|
||||
```markdown
|
||||
# YYYY-MM-DD 工作日志
|
||||
|
||||
## 当日工作内容
|
||||
|
||||
## 遗留问题
|
||||
|
||||
## TODO
|
||||
```text
|
||||
document/development/YYYY-MM-DD/dev-logs/bugs/<bug-slug>.md
|
||||
```
|
||||
|
||||
Keep this order stable. Add entries under the existing headings instead of creating duplicate headings.
|
||||
The file must contain `## 修复记录` and timestamped bullets similar to the old `当日工作内容`.
|
||||
Do not add `遗留问题` or `TODO` sections to bug logs.
|
||||
|
||||
Use the helper when possible:
|
||||
|
||||
```bash
|
||||
python3 tools/agent-change-log/update_change_log.py \
|
||||
--kind bug \
|
||||
--bug-title "<bug 名称>" \
|
||||
--bug-slug <bug-slug>
|
||||
```
|
||||
|
||||
## Required Git Check
|
||||
|
||||
Before writing or updating the daily log, manually check Git for upstream and local-ahead commits from other agents.
|
||||
Before writing or updating a bug log, manually check Git for upstream and local-ahead commits from other agents.
|
||||
|
||||
Run:
|
||||
|
||||
@@ -68,27 +76,59 @@ Rules:
|
||||
- Treat `HEAD..@{u}` as upstream commits not yet in local history.
|
||||
- Treat `@{u}..HEAD` as local commits not yet in upstream history; these may also come from another agent working in the same checkout.
|
||||
- If the worktree is clean and the branch is only behind upstream, `git pull --ff-only` may be used to fast-forward before analysis.
|
||||
- If the worktree is dirty, diverged, or likely to conflict, do not merge/rebase automatically. Record the upstream commits from `HEAD..@{u}` and the blocker in `遗留问题`.
|
||||
- If there is no upstream branch, record that fact in `遗留问题` and continue with local-only logging.
|
||||
- When `HEAD..@{u}` has commits, summarize those commits under `当日工作内容` before describing local edits. Mention commit hash, subject, and inferred impact.
|
||||
- If the worktree is dirty, diverged, or likely to conflict, do not merge/rebase automatically. Record the upstream commits from `HEAD..@{u}` in the bug fix entry.
|
||||
- If there is no upstream branch, record that fact in the bug fix entry and continue with local-only logging.
|
||||
- When `HEAD..@{u}` has commits, summarize those commits in the bug fix entry before describing local edits. Mention commit hash, subject, and inferred impact.
|
||||
- When `@{u}..HEAD` has commits that were not created in the current task, summarize them too, because another local agent may have committed without pushing yet.
|
||||
- When no upstream or local-ahead commits exist, still record "Git 提交检查:未发现 upstream 新提交或本地 ahead 新提交" in the work entry.
|
||||
|
||||
## Entry Rules
|
||||
## Bug Entry Rules
|
||||
|
||||
1. Get the current local time first:
|
||||
```bash
|
||||
date '+%Y-%m-%d %H:%M:%S %Z'
|
||||
```
|
||||
2. Run the required Git check and capture whether upstream or local-ahead has new commits.
|
||||
3. Append a new timestamped bullet under `## 当日工作内容`.
|
||||
4. Mention Git commits, changed files or modules, the operation, the intent, and the verification result.
|
||||
5. Add or update `## 遗留问题` whenever there is risk, uncertainty, skipped verification, design debt, Git divergence, or a likely follow-up.
|
||||
6. Add or update `## TODO` with checkbox items.
|
||||
7. When a TODO is completed, keep it in place and mark it as:
|
||||
```markdown
|
||||
- [x] ~~任务内容~~(完成于 HH:MM,证据:...)
|
||||
```
|
||||
3. Ensure `document/development/YYYY-MM-DD/dev-logs/bugs/` exists.
|
||||
4. Create or update one `<bug-slug>.md` file for the specific bug.
|
||||
5. Append a new timestamped bullet under `## 修复记录`.
|
||||
6. Mention Git commits, changed files or modules, the operation, the intent, and the verification result.
|
||||
7. Do not add leftover issue or TODO sections.
|
||||
|
||||
## Daily Summary
|
||||
|
||||
At 17:00 every day, generate the combined work log:
|
||||
|
||||
```bash
|
||||
python3 tools/agent-change-log/update_change_log.py --kind summary
|
||||
```
|
||||
|
||||
This reads:
|
||||
|
||||
```text
|
||||
document/development/YYYY-MM-DD/feature/
|
||||
document/development/YYYY-MM-DD/dev-logs/bugs/
|
||||
```
|
||||
|
||||
Then writes:
|
||||
|
||||
```text
|
||||
document/development/YYYY-MM-DD/work-logs.med
|
||||
```
|
||||
|
||||
The summary should cover:
|
||||
|
||||
- Today's feature points from `feature/*/CONCEPT.md` and `TODO.md`.
|
||||
- Today's bug fixes from `dev-logs/bugs/*.md`.
|
||||
- A concise combined analysis of what changed that day.
|
||||
|
||||
## Entry Rules
|
||||
|
||||
- For each bug entry, append a new timestamped bullet under `## 修复记录`.
|
||||
- Mention Git commits, changed files or modules, the operation, the intent, and the verification result.
|
||||
- Do not write `遗留问题`.
|
||||
- Do not write `TODO`.
|
||||
- If the change is a feature rather than a bug, use the development document skill to keep `feature/<feature-point>/CONCEPT.md` and `TODO.md` current instead of writing a bug log.
|
||||
|
||||
## Writing Style
|
||||
|
||||
@@ -97,12 +137,11 @@ Rules:
|
||||
- Keep the tone factual. Do not turn the log into a victory lap.
|
||||
- Prefer concise file names and module names in prose, but include enough context to find the change.
|
||||
- Work content should be detailed enough that a future agent can continue without asking "你到底改了啥?"
|
||||
- Leftover issues should include a suggested next step, not only a complaint.
|
||||
|
||||
## Work Content Template
|
||||
## Bug Entry Template
|
||||
|
||||
```markdown
|
||||
- HH:MM:我完成了 <本次修改目标>。
|
||||
- HH:MM:记录 bug 修复:<bug 名称>。
|
||||
- Git 提交检查:<git fetch 后 HEAD..upstream 与 upstream..HEAD 的结果;没有就写未发现 upstream 或本地 ahead 新提交>。
|
||||
- 修改:<文件/模块>,<做了什么>。
|
||||
- 操作:<运行了什么命令、迁移了什么状态、重启了什么服务等>。
|
||||
@@ -110,26 +149,12 @@ Rules:
|
||||
- 影响:<用户可见变化或工程边界变化>。
|
||||
```
|
||||
|
||||
## Leftover Issue Template
|
||||
|
||||
```markdown
|
||||
- HH:MM:<遗留问题或风险>。建议下一步 <具体建议>。
|
||||
```
|
||||
|
||||
## TODO Template
|
||||
|
||||
```markdown
|
||||
- [ ] <下一步动作>(来源:HH:MM <上下文>)
|
||||
- [x] ~~<已完成动作>~~(完成于 HH:MM,证据:<命令/文件/结果>)
|
||||
```
|
||||
|
||||
## Final Response Checklist
|
||||
|
||||
Before saying work is complete:
|
||||
|
||||
- Today's `document/work-log/YYYY-MM-DD.md` exists.
|
||||
- The Git check ran, and upstream plus local-ahead commits from other agents were summarized or explicitly marked as absent.
|
||||
- `当日工作内容` includes this modification batch.
|
||||
- `遗留问题` is either updated with real risks or explicitly says no new leftover issue for this batch.
|
||||
- `TODO` contains new follow-ups and completed items are checked with evidence.
|
||||
- The final response mentions that the work log was updated.
|
||||
- For bug fixes, today's bug log exists under `document/development/YYYY-MM-DD/dev-logs/bugs/`.
|
||||
- For non-bug feature work, relevant `feature/<feature-point>` documents are current.
|
||||
- Git check ran for bug logs, and upstream plus local-ahead commits were summarized or explicitly marked as absent.
|
||||
- No new legacy `document/work-log/YYYY-MM-DD.md` entry was created.
|
||||
- The final response mentions whether a bug log, feature document, or daily `work-logs.med` was updated.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
interface:
|
||||
display_name: "Agent Change Log"
|
||||
short_description: "Record X-Financial changes plus upstream/local commits in the daily work log"
|
||||
default_prompt: "Use $agent-change-log after a bug fix, feature, refactor, upstream/local commit check, or other file modification to update document/work-log/YYYY-MM-DD.md incrementally."
|
||||
short_description: "Record bug logs and daily work summaries"
|
||||
default_prompt: "Use $agent-change-log after an X-Financial bug fix or at 17:00 to update document/development/<date>/dev-logs/bugs or work-logs.med."
|
||||
|
||||
Reference in New Issue
Block a user