[workflow-style] Normalize report formatting for non-compliant workflows

オープン 初心者向け
  • 何か問題がありますか？
#75,172 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
77/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
github-actions, markdown
領域
ci-cd, documentation

調査の方向性

.github/workflows/daily-work-queues-report.md と .github/workflows/metrics-collector.md を読み、レポートに関する指示を .github/workflows/daily-repo-chronicle.md および .github/workflows/audit-workflows.md の指示と比較してください。両方のワークフロープロンプトを更新し、必須の見出し、折りたたみ可能な詳細、レポートの順序、表示する指標と制約、実行リンクの形式を指定してください。両方のプロンプトにこれらの要件が記載され、その後のアクティブな実行で、結論が見える状態で長い証拠が折りたたまれたレポートが生成されたら完了です。

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

説明

automation cookie documentation
Summary

Two active reporting workflows need consistent Markdown output guidance so their reports are easier to scan and more trustworthy for readers.

Findings
Workflow Gaps
.github/workflows/daily-work-queues-report.md Relies on the reporting import but does not explicitly require h3-or-lower report headers or <details> blocks for long queue details. Its output instructions describe useful content, but not a complete overview → key metrics → collapsible details → next actions structure.
.github/workflows/metrics-collector.md Collects and summarizes metrics but does not specify h3-or-lower headers, progressive disclosure for long output, or a clear reader-facing report structure.
Required Changes

For each workflow:

  1. State that generated report headers must use ### or lower; reserve h1/h2 for the surrounding GitHub page.
  2. Require <details><summary><b>...</b></summary>...</details> for long tables, item lists, raw evidence, and detailed findings.
  3. Define a consistent report structure: overview → key metrics/issues → collapsible detail → next actions or limitations.
  4. Keep decision-relevant metrics and limitations visible before the collapsible sections.
  5. Use workflow run links in the standard [§RUN_ID](https://github.com/owner/repo/actions/runs/RUN_ID) form where runs are referenced.
Example
### Overview

One-paragraph conclusion and the most important limitation.

### Key Metrics

| Metric | Value |
|---|---:|
| Queue items | 12 |

<details>
<summary><b>Detailed findings</b></summary>

Long tables, evidence, and item-level context belong here.

</details>

### Next Actions

- [ ] Confirm the highest-priority item.

Use .github/workflows/daily-repo-chronicle.md and .github/workflows/audit-workflows.md as reference patterns for concise, user-focused reports with visible conclusions and collapsed detail.

Acceptance Criteria
  • Both workflow prompts explicitly document h3-or-lower headers.
  • Both prompts explicitly document progressive disclosure with <details> and bold summaries.
  • Both prompts define the overview → metrics/issues → detail → next-actions structure.
  • A subsequent active run produces reports that preserve visible conclusions while collapsing long evidence.

This issue consolidates the findings from the daily workflow-style review for the last 24 hours.

Generated by 🔧 Workflow Normalizer · codex · gpt56 · ~4 AIC · ⌖ ~1 AIC · ⊞ 15.3K · ◷

  • expires on Nov 6, 2026, 4:56 AM UTC-08:00
主要言語
Go
スター
5.6k
フォーク
615
平均マージ
5時間 36分
マージ済み PR（30日）
805

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

github/gh-aw のほかの issue

github/gh-aw の issue をすべて見る

似ている issue

Go の issue をもっと見る

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

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