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

未关闭 适合新手
  • 哪里不对？
#77,449 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
62/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
github-actions, markdown
领域
devtools, documentation

调研方向

从两个指定的工作流提示词开始，即 .github/workflows/daily-astrostylelite-markdown-spellcheck.md 和 .github/workflows/daily-compiler-threat-spec-optimizer.md，找到它们的输出指引部分。以 daily-repo-chronicle.md、audit-workflows.md 和共享的报告 skill 作为参考模式。当每个提示词都明确要求使用 h3 或更低级别的标题、对较长证据使用可折叠的 details，并按概览、指标/issue、证据、后续行动的顺序输出时，即完成。

由索引模型根据 Issue 内容生成。

描述

cookie
Overview

The last-24-hour workflow-style review found two active reporting workflows whose report instructions do not explicitly establish all three project conventions: h3-or-lower headings, progressive disclosure with <details>, and a clear overview → key metrics/issues → detailed evidence → next actions structure.

Review scope
  • Workflows reviewed: 36 active reporting/documentation workflows
  • Valid run metadata pairs: 290
  • Skipped malformed or incomplete run directories: 181
  • Non-compliant workflows: 2
  • Duplicate checks: no visible matching open issue or unmerged Copilot PR was returned; the GitHub integration filtered parts of the search response and rejected unsupported PR search fields/qualifiers
Non-compliant workflows and required changes
Workflow Findings Required change
.github/workflows/daily-astrostylelite-markdown-spellcheck.md The output guidance shows a collapsible details example, but does not explicitly require h3-or-lower report headings or define a consistent report structure. Add explicit h3+ heading guidance; require long findings/details to use <details><summary><b>...</b></summary>...</details>; define overview → key metrics/issues → detailed findings → next actions.
.github/workflows/daily-compiler-threat-spec-optimizer.md The output guidance asks for collapsible content but does not explicitly require h3-or-lower report headings or define the report sequence. Add explicit h3+ heading guidance; require progressive disclosure for long evidence; define the same visible-summary and collapsible-detail structure.
Recommended format

Use a concise visible summary followed by collapsible evidence:

Detailed findings

Long tables, raw logs, and per-item evidence belong here.

Good references

Use .github/workflows/daily-repo-chronicle.md, .github/workflows/audit-workflows.md, and the shared reporting skill as reference patterns. Keep critical decisions visible, use - [ ] for follow-up actions, and include workflow run references as [§12345](https://github.com/owner/repo/actions/runs/12345) where applicable.

Acceptance criteria
  • Both workflows explicitly require h3-or-lower headings in generated reports.
  • Both workflows specify <details> progressive disclosure for long content.
  • Both workflows specify the overview → key metrics/issues → detailed evidence → next actions order.
  • The next review reports both workflows as compliant.

Generated by 🔧 Workflow Normalizer · codex · gpt56 · ~5 AIC · ⌖ ~1 AIC · ⊞ 15.5K · ◷

  • expires on Nov 14, 2026, 4:56 AM UTC-08:00
主要语言
Go
星标
5.6k
派生
625
平均合并
5 小时 42 分钟
30 天内合并 PR
796

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

github/gh-aw 的其他 Issue

查看 github/gh-aw 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。