Add mandatory API report regeneration instruction to repo-wide agent config
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 85/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
- 技術スタック
- typescript
調査の方向性
.fullsend/AGENTS.md を開き、既存の changeset に関するガイダンスを見つけます。その後に、API レポートを再生成するための提案された必須手順を追加します。これには workspace のルートから実行するコマンドと、report.api.md を更新する要件を含めます。リポジトリ全体のエージェントガイダンスで、公開エクスポートの変更に対してこの検証を明示的に必須としていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
What happened
On PR #3746, the code agent modified public API exports in the boost plugin (added @backstage/plugin-permission-react dependency, new i18n keys, new utility exports) but did not regenerate report.api.md. This required two /fs-fix iterations (fix 1, fix 2) totaling approximately 25 minutes of agent compute time and two rounds of human intervention by mareklibra. The same pattern occurred on PR #3742 (ai-integrations workspace, 2 fix iterations) and PR #3743 (boost workspace). The boost workspace AGENTS.md lists yarn tsc:full && yarn build:api-reports:only as a build command, but this listing is descriptive rather than prescriptive — the code agent treats it as reference material, not as a mandatory verification step.
What could go better
The code agent should regenerate API reports as part of its verification phase whenever it modifies public exports. The existing workspace-specific AGENTS.md files list the command but don't frame it as mandatory. Issue #3757 proposes adding the instruction to the ai-integrations workspace AGENTS.md, but the problem recurs across multiple workspaces (boost, ai-integrations), making a repo-wide instruction more effective. Confidence: high — this is a clear, recurring pattern with three data points across two workspaces.
Proposed change
Add the following instruction to .fullsend/AGENTS.md, after the existing changeset guidance:
When adding, removing, or renaming public exports in any plugin package
(changes to `index.ts`, re-exported types, or API surface files), run
`yarn tsc:full && yarn build:api-reports:only` from the workspace root
(`workspaces/<workspace>/`) and include the updated `report.api.md`
files in your commit. CI will fail if API reports are stale.
This complements the workspace-specific fix proposed in #3757 by providing a repo-wide default that covers all current and future workspaces without requiring per-workspace AGENTS.md updates.
Validation criteria
The next 3 agent-authored PRs that modify public API exports (in any workspace) should include updated report.api.md files in their initial commit, without requiring /fs-fix iterations for API report regeneration.
Generated by retro agent from https://github.com/redhat-developer/rhdh-plugins/pull/3746
- 主要言語
- TypeScript
- スター
- 50
- フォーク
- 121
- 平均マージ
- 1日 10時間
- マージ済み PR（30日）
- 258
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
redhat-developer/rhdh-plugins のほかの issue
-
feature fullsend ready-for-triage Review effort 1/5 triaged
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
redhat-developer/rhdh-plugins#4799 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
Add entity provider implementation conventions to ai-integrations AGENTS.md再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープンdocumentation ready-for-triage ready-to-code Review effort 1/5 workspace/ai-integrations
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
redhat-developer/rhdh-plugins#4781 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
Add public export surface review guidance to scorecard AGENTS.md対応中かも @fullsend-ai-coder が 39 日前に担当しました。 オープンdocumentation ready-for-triage ready-to-code Review effort 1/5 workspace/scorecard
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
redhat-developer/rhdh-plugins#4777 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
Add collector parameter contract assertion convention to scorecard AGENTS.md対応中かも @fullsend-ai-coder が 40 日前に担当しました。 オープンdocumentation ready-for-triage ready-to-code workspace/scorecard
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
redhat-developer/rhdh-plugins#4734 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
Add DORA collector pipeline and time-window boundary guidance to scorecard AGENTS.md対応中かも @fullsend-ai-coder が 40 日前に担当しました。 オープンdocumentation ready-for-triage ready-to-code workspace/scorecard
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
redhat-developer/rhdh-plugins#4733 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
redhat-developer/rhdh-plugins の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
awesome-dsh-plugin/awesome-dsh-plugin#9184 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
farion1231/cc-switch#8829 ·
メンテナーはふだん 1 日以内に返信
-
[core-client] Remove unused hand-maintained transport helpers after the definition-table cutoverオープンdoc-audit enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100