Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add structured Changes blocks to Crane accepted iteration commits

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#5 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
markdown
Lĩnh vực
tooling

Hướng nghiên cứu

Bắt đầu bằng cách đọc Step 5a trong workflows/crane.md và kiểm tra nội dung hiện có của accepted-iteration commit prompt cùng summary fallback. Cập nhật prompt để yêu cầu block Changes: dạng ngắn gọn trước Run: {run_url}, sau đó thêm prompt test được đề xuất để xác minh subject template, thứ tự và hướng dẫn fallback.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement

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 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.

Ngôn ngữ chính
Python
Star
10
Fork
0
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của githubnext/crane

Tất cả issue của githubnext/crane

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.