提交拉取请求
确保 Rush 工具已安装,按照构建项目说明进行操作。
为 monorepo 中的所有项目安装依赖项
# Run this command in the folder where you cloned the TSDoc repo from GitHub
$ rush install注意:在您运行
rush install
后,您的仓库将处于“Rush-linked”状态,在 node_modules 文件夹中带有特殊的符号链接。请勿在此状态下运行npm install
。如果您想返回到独立模式工作,请先运行rush unlink && rush purge
。构建和测试 monorepo 中的所有项目
$ rush build
您也可以像这样仅构建 @microsoft/tsdoc 库
$ cd ./tsdoc
$ npm run build手动测试:在提交 PR 之前,您还应该尝试运行 /api-demo 和 /playground 项目,以确保它们没有被您的更改破坏。
变更日志:如果您的 PR 修改了已发布的 NPM 包,您将需要为我们的 CHANGELOG.md 变更日志编写一个变更条目。请阅读关于编写变更日志的“推荐做法”。
$ rush change
# (The tool will ask you to write a sentence describing your change.)rush change
命令将在 common/changes 文件夹下创建一个文件。将此文件添加到 Git 并包含在您的拉取请求中。有关如何使用这些文件的更多详细信息,请参阅日常命令。
贡献者须知
本项目欢迎贡献和建议。大多数贡献要求您同意贡献者许可协议 (CLA),声明您有权并实际授予我们使用您的贡献的权利。有关详细信息,请访问 https://cla.microsoft.com。
当您提交拉取请求时,CLA 机器人将自动确定您是否需要提供 CLA,并适当地装饰 PR(例如,标签、评论)。只需按照机器人提供的说明进行操作即可。您只需在使用我们 CLA 的所有仓库中执行此操作一次。
本项目已采用Microsoft 开放源代码行为准则。有关更多信息,请参阅行为准则 FAQ 或联系 opencode@microsoft.com 以获得任何其他问题或评论。