贡献

感谢您对该项目的贡献兴趣！

警告: ⚠️ 降低新函数的速度

随着 VueUse 受众的不断增长，我们收到了大量的功能请求和拉取请求。因此，维护项目变得越来越困难，已经将我们的能力推向了极限。因此，在不久的将来，我们可能需要降低对新功能的接受速度，并优先考虑现有函数的稳定性和质量。请注意，目前可能不会接受 VueUse 的新功能。 如果您有任何新想法，建议您首先将其纳入自己的代码库，对其进行迭代以满足您的需求，并评估其通用性。如果您坚信您的想法对社区有益，可以提交一个包含用例的拉取请求，我们将很乐意审查和讨论。感谢您的理解。

开发

设置

将此仓库克隆到您的本地机器并安装依赖项。

pnpm install

我们使用 VitePress 进行快速开发和文档编制。您可以通过以下方式在本地启动它

pnpm dev

贡献

现有函数

您可以随意增强现有函数。请尽量避免引入重大更改。

新函数

添加新函数有一些注意事项

• 在开始工作之前，最好先打开一个 issue 进行讨论。
• 实现应作为文件夹放置在 packages/core 下，并在 index.ts 中公开。
• 在 core 包中，请尽量不要引入第三方依赖，因为这个包旨在尽可能轻量级。
• 如果您想引入第三方依赖，请为 @vueuse/integrations 贡献代码或创建一个新的附加组件。
• 您可以在 packages/core/_template/ 下找到函数模板，详细说明在 函数文件夹 部分。
• 编写函数文档时，<!--FOOTER_STARTS--> 和 <!--FOOTER_ENDS--> 将在构建时自动更新，因此您无需更新它们。

请注意，您无需更新包的 index.ts。它们是自动生成的。

新附加组件

非常欢迎添加新的附加组件！

• 在 packages/ 下创建一个新文件夹，将其命名为您的附加组件名称。
• 在 scripts/packages.ts 中添加附加组件详细信息
• 在该文件夹下创建 README.md。
• 像您对核心包所做的那样添加函数。
• 提交并提交为 PR。

项目结构

单仓库

我们使用单仓库来管理多个包

packages
  shared/         - shared utils across packages
  core/           - the core package
  firebase/       - the Firebase add-on
  [...addons]/    - add-ons named

函数文件夹

函数文件夹通常包含以下 4 个文件

您可以在 packages/core/_template/ 下找到模板

index.ts            # function source code itself
demo.vue            # documentation demo
index.test.ts       # vitest unit testing
index.md            # documentation

对于 index.ts，您应该使用名称导出函数。

// DO
export { useMyFunction }

// DON'T
export default useMyFunction

对于 index.md，第一句话将显示为函数列表中的简短介绍，因此请尽量保持简洁明了。

# useMyFunction

This will be the intro. The detail descriptions...

阅读有关 指南 的更多信息。

代码风格

只要您安装了开发依赖项，就不必担心代码风格。Git 钩子会在您提交时为您格式化和修复它们。

感谢

再次感谢您对该项目的贡献兴趣！您太棒了！