githubnext / githubnext/crane

Add structured Changes blocks to Crane accepted iteration commits

オープン 初心者向け
#5 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Python
スター
10
フォーク
0
PR マージ指標
30日以内にマージされた PR はありません

説明

## 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:

```markdown
[Crane: {migration-name}] Iteration :

Changes:
-
-

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 before `Run: {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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

まず workflows/crane.md の Step 5a を読み、既存の accepted-iteration commit prompt と summary fallback の文言を確認します。Changes: ブロックを Run: {run_url} の前に置くことを要求するように prompt を更新し、その後、subject template、順序、fallback のガイダンスを検証するため、提案された prompt test を追加します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
markdown
領域
tooling
issue の種類
機能追加
難易度
2/5
見積もり時間
1〜3時間
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
72/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。