Skip to content

docs: add devlog system for development iteration tracking#4

Merged
ranxianglei merged 1 commit into
masterfrom
2026-05-19_devlog-system
May 19, 2026
Merged

docs: add devlog system for development iteration tracking#4
ranxianglei merged 1 commit into
masterfrom
2026-05-19_devlog-system

Conversation

@ranxianglei
Copy link
Copy Markdown
Owner

Summary

Adds a structured development log (devlog/) system for tracking every development iteration with REQ + WORKLOG + optional DESIGN documents.

What's included

  • Templates: REQ.template.md, WORKLOG.template.md, DESIGN.template.md
  • README: Usage guide with naming convention (YYYY-MM-DD_short-title), rules, directory layout
  • Backfilled entries: 4 past iterations
    • 2026-05-15_acp-rebrand — DCP→ACP rebrand, 35 bug fixes
    • 2026-05-16_test-infrastructure — 95→350 test suite, 4 tiers
    • 2026-05-17_ci-setup — GitHub Actions CI
    • 2026-05-18_msgid-expansion — 4→5 digit message ref expansion
  • AGENTS.md updates: Section 5.1.2 mandates devlog for every PR, updated test count (350), CI status

Why

Git history tells you what changed, but not why or how the decision was made. The devlog system provides structured, searchable context for each iteration — especially valuable for AI-assisted development where context can be lost between sessions.

- devlog/README.md: usage guide, naming convention (YYYY-MM-DD_short-title)
- REQ.template.md: problem statement, acceptance criteria, constraints
- WORKLOG.template.md: commits, key files, test results, lessons learned
- DESIGN.template.md: architecture decisions (required for major changes)
- Backfilled 4 past iterations: acp-rebrand, test-infrastructure, ci-setup, msgid-expansion
- AGENTS.md Section 5.1.2: devlog mandatory for every PR
- Updated: test count 343→350, CI status, module map
@ranxianglei ranxianglei merged commit 1bf8fd9 into master May 19, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant