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

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

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
86/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
静か
領域
documentation

調査の方向性

指定された4つのファイル—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日 16時間
マージ済み PR（30日）
275

環境構築

はじめの一歩

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

redhat-developer/rhdh-plugins のほかの issue

redhat-developer/rhdh-plugins の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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