Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Add mandatory API report regeneration instruction to repo-wide agent config

Chiusa Adatta ai principianti
  • Qualcosa non va?
#4,392 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
85/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
developer-experience, documentation

Direzione di ricerca

Apri .fullsend/AGENTS.md e individua le indicazioni esistenti sui changeset. Aggiungi dopo di esse l’istruzione obbligatoria proposta per rigenerare il report dell’API, includendo il comando da eseguire dalla radice del workspace e il requisito di aggiornare report.api.md. Il lavoro è completato quando le indicazioni dell’agente a livello di repository richiedono esplicitamente questa verifica per le modifiche alle esportazioni pubbliche.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement feature fullsend Review effort 1/5 stale triaged

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

Lingua principale
TypeScript
Stelle
50
Fork
121
Merge medio
1g 11h
PR unite (30g)
246

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di redhat-developer/rhdh-plugins

Tutte le issue di redhat-developer/rhdh-plugins

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.