Skip to content

对 es‐toolkit compat 的贡献

Sojin Park edited this page Mar 21, 2025 · 1 revision

感谢您有兴趣为我们的库做出贡献!

我们正在构建一个名为es-toolkit/compat兼容层,它的工作方式与lodash完全相同,使迁移变得更加容易。以下是您可以提供帮助的方式:

1. 选择一个要实现的函数

查看这个GitHub问题以找到仍需要实现的函数。浏览子问题以找到一个您感兴趣的函数。

find-a-function

2. 了解函数的工作原理

在编码之前,请确保您通过查看以下内容完全了解函数的行为:

Lodash的v5-wip分支中的测试文件命名为{functionName}.test.js,对于理解预期行为至关重要。

read-test

3. 实现并测试您的函数

将您的实现添加到compat目录

为了进行测试,从Lodash的v5-wip分支复制测试代码,以确保100%兼容。

实现检查清单:

  • 您的函数签名是否与@types/lodash中的类型匹配?
  • 您是否已从Lodash复制测试代码以验证相同的行为?

4. 添加JSDoc注释

为您的函数添加清晰的JSDoc注释,并附带有用的示例。您可以使用AI工具,使用类似这样的提示:

为每个函数声明添加JSDoc注释,在每个函数中包含有用的示例。用markdown打印代码。
{您的代码放在这里}

5. 创建文档

我们需要多种语言的文档文件。如果您的代码在./src/array/test.ts中,则创建以下位置的文档:

  • 英语:./docs/reference/array/test.md
  • 中文(简体):./docs/zh_hans/reference/array/test.md
  • 日语:./docs/ja/reference/array/test.md
  • 韩语:./docs/ko/reference/array/test.md

使用我们的文档生成器

为了使这更容易,我们创建了一个自动化脚本。首先,如果您还没有安装Deno

curl -fsSL https://deno.land/install.sh | sh

然后运行我们的文档生成器:

# 从存储库根目录运行
deno run -A ./.scripts/docs/generate-docs.mts

翻译文档

由于我们的库在全球范围内使用,我们重视翻译。如果您有OpenAI API密钥,可以自动化翻译:

OPENAI_API_KEY=your_key_here deno run -A ./.scripts/docs/generate-docs.mts