Write a slot best practices how-to
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 55/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- markdown, typescript
- Ambito
- documentation, frontend
Direzione di ricerca
Start with ADR 0009 (docs/decisions/0009-slot-naming-and-lifecycle.rst), sections 2 and 3, then the existing files in docs/how_tos/, especially the slot section of the migration how-to. Create docs/how_tos/slot-props.md covering the classification of prop changes and the additive and breaking paths, with a @deprecated TypeScript example. Done when the guide is linked from the ADR's Consequences section and the migration how-to, and the three open questions are either answered or explicitly flagged for maintainers.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
[!NOTE]
This issue was written by Claude (Claude Code) and reviewed before posting.
Goal: a how-to in docs/how_tos/ that walks an app maintainer through renaming or changing a slot prop: what the change does to the slot's contract, which path it takes, and what the plugin author sees along the way.
Why: ADR 0009 sets the rules but not the steps. Section 2 makes props the contract ("a given slot's API contract is comprised of: Its React props, with the notable exclusion of props.children") and says the version increments when a change means "existing widgets can be reasonably expected to break". Section 3 says the previous version is deprecated through the Open edX DEPR process and kept "for the duration of the deprecation process, which should include at least one Open edX release where it co-exists with the new version". Nothing in docs/how_tos/ (automatic-case-conversion, caching, i18n, migrate-frontend-app, permissions, theming) turns that into a procedure; the migration how-to's slot section covers only the move from <PluginSlot /> to <Slot /> and re-naming ids.
The gap shows in review. openedx/frontend-app-catalog#174 renames the catalog page's data layer and its internals but keeps the slot props courseDataResultsLength and totalCourses under their old names "so existing site plugins keep working", because there is no documented way to do otherwise. The additive path (add the new prop beside the old one, mark the old one deprecated, remove it at the next slot version) fits ADR 0009 as written, but a maintainer has to work that out from the ADR each time, and nothing says how to mark the deprecation so a plugin author notices.
Claude Plan
Written 2026-11-02 against ae5ec93 on main.
What the how-to would cover
- Classifying the change. A new optional prop: additive, no version change. A renamed prop: additive if the old name stays for a release, breaking if it goes at once. A prop whose type changes: breaking when existing widgets stop compiling or misbehave (the question of what a prop's type exposes is #339, which this guide defers to). A removed prop: breaking.
- The additive path for a rename. Add the new prop; keep the old one, forwarding to the new one in the slot's default content; mark the old one deprecated in the TypeScript (
@deprecatedon the interface member, naming the replacement and the version it goes away in) and in the slot's README; note it in the release notes (conventional-commits footer); remove it at the next slot version via the ADR 0009 section 3 process. - The breaking path. When the additive path is not possible:
v2slot id, both versions rendered for a release, DEPR ticket, the README documenting both. - What the plugin author sees. The
@deprecatedtag in their editor, the README's deprecation note, the release note; and the one place to look for the replacement. - A worked example, taken from a real slot once one has gone through the path.
Open questions
- Whether a deprecated prop needs a DEPR ticket of its own or rides on the slot version's DEPR when it is finally removed.
- Whether pre-release apps (frontend-app-catalog has published only
1.0.0-alpha.*) follow the same path or may rename outright. - Whether a lint rule or type-level check should enforce that a renamed prop keeps its old name for a release, or whether the how-to is enough.
Where it lives
docs/how_tos/slot-props.md (or a broader docs/how_tos/slots.md if the scope grows), linked from ADR 0009's Consequences section and from the migration how-to's slot section.
- Lingua principale
- TypeScript
- Stelle
- 4
- Fork
- 13
- Merge medio
- 3g 5h
- PR unite (30g)
- 4
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di openedx/frontend-base
-
Export `SkipLink` componentAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
openedx/frontend-base#330 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
openedx/frontend-base#327 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
openedx/frontend-base#210 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
openedx/frontend-base#350 ·
-
External routes ignore paramsForse già presa @arbrandes l’ha presa oggi. Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
openedx/frontend-base#349 · 1 assegnatario ·
Tutte le issue di openedx/frontend-base
Issue simili
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P3
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
openclaw/openclaw#200365 · 1 commento · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
effort: small good first issue priority: medium testing
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
TMHSDigital/screencast-mcp#351 ·
I maintainer di solito rispondono entro 1 giorno
-
area-templates triage:bot-seen triage:needs-human
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
microsoft/aspire#22356 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Archiving an agent that is not loaded keeps its old updatedAtForse già presa @luoph l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno
-
content triage
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno