[guidelines] workshop-builder.md: stale "section 2c" reference and --validate overuse

已关闭 适合新手
#4,128 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
88/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
领域
documentation

调研方向

打开 .github/workflows/workshop-builder.md,检查过时的章节引用以及两处 --validate 说明。将编译指南与 .github/workflows/guidelines.md 进行比较,然后酌情更新措辞或命令。完成标准是:引用使用当前 heading 的名称,且编译说明遵循文档记录的默认值和例外情况。

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

描述

documentation guidelines guidelines-violation

File reviewed

.github/workflows/workshop-builder.md

Violations

Stale internal section reference

Offending text:

Record:

  • Whether the open PRs and issues satisfy the label-based blockers in the
    eligibility table in section 2c

Suggested fix:
The file has no section literally labeled "2c" — headings in this file are not numbered (per the "Header style" rule). This appears to reference the "### Derive dispatch eligibility" subsection (under "## Assess Workshop Health"). Replace "section 2c" with a direct reference to that heading name, e.g. "the eligibility table under Derive dispatch eligibility", so the instruction stays accurate if headings are reordered.

Compile defaults — --validate used as default in Tier B

Offending text:

  1. Use the agentic-workflows compile tool with --validate on each file to
    surface any schema errors or deprecated fields

and

  1. Re-run agentic-workflows compile with --validate on the modified file to
    confirm the change is valid; fix any errors before proceeding

Suggested fix:
Per the "Compile defaults" rule in .github/workflows/guidelines.md, --validate should be reserved for targeted troubleshooting or schema/deprecation audits, not used as the default compile invocation. Consider whether these specific audit-style uses (schema/deprecation scan, post-edit validation) qualify as the allowed exception, or switch to the plain compile call and only add --validate when an error needs isolating.

Generated by 📋 Guidelines Enforcer · copilot · auto · 125.9 AIC · ⌖ 5.44 AIC · ⊞ 9.6K · ◷

  • expires on Oct 10, 2026, 4:12 AM UTC
主要语言
JavaScript
星标
56
派生
40
平均合并
2 天 14 小时
30 天内合并 PR
13

环境准备

在 Codespaces 中打开

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

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

从这里开始

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

githubnext/gh-aw-workshop 的其他 Issue

查看 githubnext/gh-aw-workshop 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

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