Add prettier CI gate documentation to 4 workspace AGENTS.md files that omit it

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

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

调研方向

将四个指定文件—workspaces/ai-integrations/AGENTS.md、workspaces/intelligent-assistant/AGENTS.md、workspaces/mcp-integrations/AGENTS.md 和 workspaces/scorecard/AGENTS.md—与 x2a AGENTS.md 参考文件进行比较。使用各自现有的文档风格更新每个文件，然后运行 grep -rl 'prettier' workspaces/*/AGENTS.md | wc -l；结果为 7 即表示完成。

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

描述

documentation ready-for-triage ready-to-code stale workspace/ai-integrations workspace/intelligent-assistant workspace/mcp-integrations workspace/scorecard

What happened

The boost workspace AGENTS.md repeatedly caused prettier CI failures because the formatting gate was undocumented or insufficiently prominent — first in PR #4189 (leading to #4219), then again in PR #4312 (leading to #4327 and this PR #4330). Each failure required human intervention (/fs-fix) and ~12-14 min of fix agent time.

Investigating whether this gap is systemic, I audited all 7 workspace AGENTS.md files. Only 3 of 7 mention prettier (boost after PR #4330, x2a, and cost-management). The remaining 4 — ai-integrations, intelligent-assistant, mcp-integrations, and scorecard — have zero prettier documentation despite prettier being a repo-level CI gate enforced on all workspaces.

What could go better

The retro agent correctly identifies and fixes this class of issue one workspace at a time, but doesn't check whether sibling workspaces have the same gap. This means the system waits for each workspace to independently fail CI before fixing its AGENTS.md — a reactive pattern that costs ~12 min of fix agent time plus human intervention per failure.

The rhdh-workspace skill does mention yarn prettier:check in its "Before finishing" section, which should theoretically catch this regardless of what workspace AGENTS.md says. However, the evidence from PR #4312 shows that agents prioritize the workspace-specific Build & verify table over the skill's instructions, so the workspace docs need to be complete.

Confidence: High that these 4 workspaces will eventually hit the same CI failure if agents make formatting-sensitive changes there. The prettier check is repo-wide, not boost-specific.

Proposed change

Add prettier documentation to the 4 workspace AGENTS.md files that currently omit it:

  1. workspaces/ai-integrations/AGENTS.md — add yarn prettier:fix to the Build & Test Commands section
  2. workspaces/intelligent-assistant/AGENTS.md — add a prettier line (this file is only 28 lines; even a brief mention helps)
  3. workspaces/mcp-integrations/AGENTS.md — add a prettier line (34 lines; similarly sparse)
  4. workspaces/scorecard/AGENTS.md — add yarn prettier:fix to the Build & Test Commands section

The format should match each workspace's existing documentation style (not all use boost's table format). The x2a workspace is a good reference for thorough prettier documentation.

Validation criteria

After the change: grep -rl 'prettier' workspaces/*/AGENTS.md | wc -l should return 7 (all workspaces). The next 5 code/fix agent runs across any of these 4 workspaces should not fail CI due to prettier formatting mismatches.

Generated by retro agent from https://github.com/redhat-developer/rhdh-plugins/pull/4330

主要语言
TypeScript
星标
51
派生
122
平均合并
1 天 15 小时
30 天内合并 PR
241

环境准备

从这里开始

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

redhat-developer/rhdh-plugins 的其他 Issue

查看 redhat-developer/rhdh-plugins 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

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