关于 pr
用于准备和提交 Remotion 拉取请求的仓库技能,涵盖分支与 PR 检查、格式化、构建和样式验证、提交及文档预览链接。
主要功能
- 01检查分支和现有 PR 状态
- 02仅格式化受影响的文件
- 03运行构建和样式检查
- 04提交并推送更改
- 05为更改的文档添加预览链接
适用场景
- 01准备 Remotion 更改以供审查
- 02更新现有分支的拉取请求
- 03为已更改的文档页面添加预览链接
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ remotion-dev/ remotion --skill pr安装后在 Claude Code 中输入/pr确认已加载。
详细介绍
确保当前不在 main 分支上;如有必要,创建一个分支。
使用 gh pr status 或 gh pr view 检查当前分支是否已有 PR。如果有,请将本地更改更新到该 PR 中。
除非用户明确要求,否则不要将新编写的 Agent 测试(包括现有文件中的新测试用例)纳入 PR。必要时可以更新现有测试、固定数据和快照,以支持本次更改。检查差异并保留用户之前已有的更改。
如果更改添加了 Remotion Element,请先阅读 Element 贡献指南。
对本次更改涉及的文件或包目录运行 Oxfmt。传入实际路径;不要假设仓库根目录下有 src 目录。包含相关的根目录文件,不要格式化无关的包或整个仓库。
例如:
bunx oxfmt <changed-file-or-package-directory>... --write
如果更改的文件都不受 Oxfmt 支持,则跳过此步骤。提交前检查格式化带来的更改。
然后运行
bun run build
bun run stylecheck
以确保编译成功,且 CI 的 lint 和格式检查通过。
只提交一次更改。PR 标题必须符合 pr-name 技能的要求。
只向远程分支推送一次更改,使用 git push -u origin HEAD。
除非用户要求,否则绝不要强制推送。
使用 gh CLI 创建拉取请求,并让标题遵循相同格式。
创建 PR 时,不要通过 shell 命令内联传入 PR 正文(例如,避免使用 --body "..." 或在 bash 中使用 heredoc)。请改为:
- 将 PR 正文写入系统临时目录中的临时 Markdown 文件(例如
/tmp/remotion-pr-body.md,或在/tmp下创建一个唯一文件)。- 如果当前工作始于、修复了或以其他方式关联到某个 GitHub issue,请在 PR 正文中加入关闭关键词,例如
Closes #1234或Closes https://github.com/owner/repo/issues/1234。如果用户的原始请求中提供了 issue 编号或 URL,请保留。
- 如果当前工作始于、修复了或以其他方式关联到某个 GitHub issue,请在 PR 正文中加入关闭关键词,例如
- 使用
gh pr create --title "<title>" --body-file <path-to-temp-md-file>创建 PR。
示例:
gh pr create --title '`@remotion/package`: Add feature' --body-file /tmp/remotion-pr-body.md
为网站中直接更改的页面添加链接
创建 PR 后,检查是否直接新增或修改了 packages/docs 中的主页面。根据页面源文件,并以 packages/docs/docusaurus.config.ts 作为路由依据,确定每个页面的公开路径。不要推断已删除页面的路径,也不要为仅影响共享组件、样式、数据或配置的更改推断路径。
创建 PR 后,最多轮询 60 秒以查找 Vercel 评论,每次检查之间等待 5 秒。从 remotion 项目行中获取 Preview 链接,并在其后附加每个页面路径;忽略 bugs 项目行。如果预览链接不可用,且部署链接只指向 Vercel 控制面板,则仅在已安装并通过身份验证的情况下使用 Vercel CLI 运行 vercel inspect <deployment-url>。否则,不要修改 PR 正文,并报告无法解析预览 URL。
只等待 Vercel 评论。不要等待部署完成,不要创建 Vercel 心跳,也不要探测预览页面。
将深层链接追加到 PR 正文的 ## Preview 部分。将当前正文获取到临时 Markdown 文件中,并使用 gh pr edit <pr> --body-file <path-to-temp-md-file> 更新;绝不要内联传入替换后的正文。
如果无法确定页面路径或预览 URL,请保持已创建的 PR 不变,并报告未添加预览链接。