这是一个关于如何向 DefinitelyTyped 提交 TypeScript 类型定义的指南。

1. 准备工作

在开始之前，请确保你已经：

  • 熟悉 TypeScript 类型系统。
  • 了解如何使用 Git 进行版本控制。
  • 熟悉 DefinitelyTyped 的贡献流程。

2. 查找或创建类型定义

首先，你需要找到一个现有的类型定义，或者创建一个新的类型定义。

  • 查找现有类型定义：在 DefinitelyTyped 的仓库中搜索你需要的类型定义。
  • 创建新类型定义：如果找不到现有类型定义，你需要创建一个新的类型定义。

3. 提交类型定义

提交类型定义时，请遵循以下步骤：

  1. 克隆 DefinitelyTyped 仓库：使用 Git 克隆 DefinitelyTyped 仓库到本地。
    git clone https://github.com/DefinitelyTyped/DefinitelyTyped.git
  2. 创建分支：为你的类型定义创建一个新的分支。
    git checkout -b <branch-name>
  3. 编写类型定义：在新的分支中编写你的类型定义。
  4. 提交更改：将你的更改提交到本地仓库。
    git add <path-to-file>
git commit -m "<commit-message>"
  5. 推送更改：将你的更改推送到 DefinitelyTyped 仓库。
    git push origin <branch-name>
  6. 等待审核：你的提交将会被审核。审核过程可能需要一些时间。

4. 示例

以下是一个简单的类型定义示例：

declare module 'example' {
  export function exampleFunction(): string;
}

5. 扩展阅读

更多关于 DefinitelyTyped 的信息，请参阅 DefinitelyTyped 官方文档。

TypeScript