Add structured Changes blocks to Crane accepted iteration commits
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 72/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- markdown
- 領域
- tooling
調査の方向性
まず workflows/crane.md の Step 5a を読み、既存の accepted-iteration commit prompt と summary fallback の文言を確認します。Changes: ブロックを Run: {run_url} の前に置くことを要求するように prompt を更新し、その後、subject template、順序、fallback のガイダンスを検証するため、提案された prompt test を追加します。
索引モデルが issue の本文から書いたものです。
説明
Background
In githubnext/apm, later Crane PR comments needed a reliable way to explain what a newly accepted commit actually did. Sometimes score fields, issue comments, or state-file summaries are unavailable, stale, or too sparse. The commit itself should carry enough structured information to be a fallback source.
APM updated its local Crane workflow prompt so accepted iteration commits include a compact Changes: section before the Run: URL.
Problem
Today an accepted Crane commit may only have a subject and a run URL. That is not enough for downstream summaries, PR comments, or issue updates to reconstruct the useful reviewer-facing facts.
When a PR has many iteration commits, reviewers need to know which module, milestone, or command family each commit advanced. A generic subject plus a workflow link forces everyone to open logs.
Proposed implementation
Update workflows/crane.md so Step 5a requires accepted iteration commit messages to use this shape:
[Crane: {migration-name}] Iteration <N>: <short description>
Changes:
- <compact bullet describing the main migrated unit or behavior change>
- <optional second bullet with test, parity, or milestone movement>
Run: {run_url}
Guidance:
- Keep
Changes:compact and structured. - Prefer one or two bullets, three max.
- Mention the migrated unit or behavior, not generic process.
- Mention test or parity movement when useful.
- Keep
Run:as the final evidence link.
The accepted-iteration summary logic should then be allowed to fall back to the commit subject plus Changes: bullets when richer state is missing.
Suggested test coverage
Add a prompt test asserting:
- The commit subject template is present.
Changes:appears beforeRun: {run_url}.- The prompt says the
Changes:block is used as summary fallback.
Acceptance criteria
- Accepted Crane commits contain structured
Changes:bullets. - Later PR or issue comments can summarize a commit without reading workflow logs.
- Existing commit subject and run-link behavior is preserved.
- The prompt test prevents regressions.
Provenance
This came from the githubnext/apm migration, where maintainer-facing summaries needed to describe what happened in each new Crane commit, not just that a commit was pushed.
- 主要言語
- Python
- スター
- 10
- フォーク
- 0
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
githubnext/crane のほかの issue
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
githubnext/crane#6 ·
-
documentation enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 58/100
githubnext/crane#8 ·
-
enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
githubnext/crane#7 ·
-
Require shared accepted-iteration summaries for Crane PR updates対応中かも @mrjf が 128 日前に担当しました。 オープンenhancement
githubnext/crane#4 · リアクション 1 件 · 担当者 2 名 ·
githubnext/crane の issue をすべて見る
似ている issue
-
upstream update
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
conan-io/conan-center-index#31098 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
john-kurkowski/tldextract#382 ·
-
comp/tools duplicate P2 sweeper:risk-compatibility tool/mcp type/bug
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
NousResearch/hermes-agent#132042 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
deepset-ai/haystack#13092 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 85/100
feder-cr/invisible_playwright_mcp#1408 ·
メンテナーはふだん 1 日以内に返信