← スキル一覧に戻る

progress-addendum
by graysurf
codex-kit tracks Codex CLI setup to keep workflows consistent across machines.
⭐ 0🍴 0📅 2026年1月25日
SKILL.md
name: progress-addendum description: Add an append-only Addendum section to DONE progress files (top-of-file), with audit + template scripts to keep archived docs from going stale.
Progress Addendum (post-DONE updates)
Contract
Prereqs:
- Run inside the target git repo (any subdir is fine).
gitavailable onPATH.python3available onPATH.
Inputs:
- A progress file path under
docs/progress/**/*.md(typicallydocs/progress/archived/<YYYYMMDD>_<slug>.md). - Update date (
YYYY-MM-DD; default: today) and the addendum content you will fill in.
Outputs:
- Progress file updated with a
## Addendumsection placed immediately afterLinks:(before## Goal). Updateddate updated (only when adding an addendum entry).- Audit script exits non-zero and prints errors to stderr when conventions are violated.
Exit codes:
0: success- non-zero: invalid args, missing file, malformed progress file, or audit failures
Failure modes:
- Progress file missing the canonical
Links:section. - Multiple
## Addendumsections detected. - File status is not
DONE(unless--allow-not-doneis set). ## Addendumexists but is not the first## ...section afterLinks:.
Principles (3a: append-only at the top)
- Goal: prevent DONE progress files from going stale without rewriting history.
- Canonical placement:
## Addendumlives immediately afterLinks:and before the rest of the document (typically## Goal). - Post-DONE edits should be limited to:
## Addendum(append-only notes)- the header table’s
Updateddate (to reflect the addendum entry)
- If the change is large, prefer creating a new progress file / PR and link it from the Addendum instead of editing the original
Goal / Acceptance Criteria / Scope / Steps.
Entry format (recommended)
### YYYY-MM-DD
- Change: ...
- Reason: ...
- Impact: ...
- Links: ...
Scripts
- Add a new entry template into a DONE progress file (and bump
Updated):$CODEX_HOME/skills/workflows/pr/progress/progress-addendum/scripts/progress_addendum.sh --file docs/progress/archived/<file>.md
- Add an entry and link to an existing follow-up progress file:
$CODEX_HOME/skills/workflows/pr/progress/progress-addendum/scripts/progress_addendum.sh --file docs/progress/archived/<file>.md --followup-progress docs/progress/<YYYYMMDD>_<slug>.md
- Create a new follow-up progress file (skeleton) and link it from the Addendum entry:
$CODEX_HOME/skills/workflows/pr/progress/progress-addendum/scripts/progress_addendum.sh --file docs/progress/archived/<file>.md --followup-title "<short title>"
- Ensure a DONE file has
## Addendum(insert- Noneif missing; does not changeUpdated):$CODEX_HOME/skills/workflows/pr/progress/progress-addendum/scripts/progress_addendum.sh --file docs/progress/archived/<file>.md --ensure-only
- Print a copy/paste entry template (no file edits):
$CODEX_HOME/skills/workflows/pr/progress/progress-addendum/scripts/progress_addendum.sh --print-entry
- Audit progress files for Addendum placement/format:
$CODEX_HOME/skills/workflows/pr/progress/progress-addendum/scripts/audit_progress_addendum.sh- Optional stricter checks:
.../audit_progress_addendum.sh --require-addendum --check-updated.../audit_progress_addendum.sh --require-links.../audit_progress_addendum.sh --require-progress-link
スコア
総合スコア
60/100
リポジトリの品質指標に基づく評価
✓SKILL.md
SKILL.mdファイルが含まれている
+20
✓LICENSE
ライセンスが設定されている
+10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
○最近の活動
3ヶ月以内に更新がある
0/10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
○タグ
1つ以上のタグが設定されている
0/5
レビュー
💬
レビュー機能は近日公開予定です