参与贡献

这一章面向想给 Cornerstone3D 官方项目（英文上游）贡献代码或文档的人。

• 如何贡献 —— 提报缺陷、提交 PR、以及更新依赖时的注意事项
• 撰写文档 —— 在本地运行文档站点
• 本地链接 —— 把本地的各个包链接起来联调
• Karma 测试 —— 单元测试
• Playwright 测试 —— 端到端与视觉回归测试

想给这份中文翻译做贡献？

上面这些讲的是官方英文仓库的流程。如果你想改进这份中文翻译—— 修正译文、统一术语、补充过时内容——请到 翻译仓库 提 Issue 或 PR。 术语请以术语对照表为准。

📄️撰写文档

为 Cornerstone3D 撰写和更新文档的指引，包括在本地运行文档服务器的命令、首次运行因 example.md 缺失而失败的解决办法，以及侧边栏不显示这类常见问题的排查。

📄️编写 Karma 测试

Cornerstone3D 渲染与工具的 Karma 测试怎么写、怎么跑。涵盖本地运行与可视化观察、用 run-karma.sh 生成 HTML 审阅报告、两类基线图片的位置与更新方式、图片对比结果的审阅面板，以及用 KARMA_GREP 只跑单个测试。

📄️链接 Cornerstone 各库

用 yarn link 把本地的 Cornerstone 库与 OHIF 链接起来做开发的分步指南，包括前置条件、单个与多个库的链接步骤、如何验证链接生效、排查改动不生效的思路，以及调试相关的几个实用技巧。

📄️编写 Playwright 测试

用 Playwright 编写端到端测试的完整指南。涵盖针对既有示例与新增示例写测试、用 checkForScreenshot 做截图比对、用 simulateDrag 模拟鼠标拖拽、run-playwright.sh 包装脚本的各项标志、更新截图基线，以及手动托管示例与 VSCode 扩展录制测试。

📄️如何贡献

为 Cornerstone3D 做贡献的指引：如何提报缺陷、如何通过 Pull Request 提交代码改动、提交改动时的若干建议，以及需要更新 package.json 依赖时必须遵循的安全审计流程。

📄️API 更新

Cornerstone3D 用 api-extractor 从代码库中提取公共 API，并在每个 PR 上与基础分支做比对。如果你有意改动了公共 API，需要运行 yarn run build:update-api 更新 API 摘要文件并一并提交。