Write a slot best practices how-to

未关闭
#340 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

@brian-smith-tcril 已经在做这个了。

开始于 2026年11月4日。

  • #344 来自 @brian-smith-tcril —— 未关闭

评估

难度
3/5
预计耗时
1-2 天
新手友好度
55/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
markdown, typescript

调研方向

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.

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

描述

[!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
  1. 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.
  2. 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 (@deprecated on 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.
  3. The breaking path. When the additive path is not possible: v2 slot id, both versions rendered for a release, DEPR ticket, the README documenting both.
  4. What the plugin author sees. The @deprecated tag in their editor, the README's deprecation note, the release note; and the one place to look for the replacement.
  5. 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.

主要语言
TypeScript
星标
4
派生
13
平均合并
3 天 5 小时
30 天内合并 PR
4

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

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

openedx/frontend-base 的其他 Issue

查看 openedx/frontend-base 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

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