贡献指南

zx 是一个完全 开源项目，由社区为社区开发。 我们欢迎任何形式的贡献，包括但不限于

• 错误报告
• 功能请求
• 代码贡献
• 文档改进
• 讨论

https://ggdocs.cn/zx/contribution

社区准则

本项目遵循 Google 开源社区准则。 简而言之：所有贡献者都受到尊重和公平对待。

贡献者许可协议

对此项目的贡献必须附带贡献者许可协议。 您（或您的雇主）保留您贡献的版权； 这仅仅允许我们使用和重新分发您的贡献作为项目的一部分。 请访问 https://cla.developers.google.com/ 查看您当前的文件协议或签署新的协议。

您通常只需要提交一次 CLA，因此如果您已经提交过一次（即使是针对不同的项目），您可能不需要再次提交。

如何贡献

在提出更改之前，请在项目的 issues 和 pull requests 中查找类似的内容。 如果您无法决定，请创建一个新的 discussion 主题，我们将帮助您解决。 准备好继续进行时

• 准备您的开发环境。

  • 切换到推荐的 Node.js 版本
    • 手动安装 Node.js >= 22。
    • 将例程委托给任何版本管理器，该管理器 支持 .node_version 配置
    • 使用 Volta，目标版本将从 package.json 自动设置
  • Bash 对于运行 zx 脚本至关重要。 Linux 和 macOS 用户通常默认安装它。 如果您使用的是 Windows，请考虑使用 Windows Subsystem for Linux 或 Git Bash。

• Fork 该仓库。

• 创建一个新分支。

• 进行更改。

  • 如果您要添加新功能，请包含其他测试。 覆盖率阈值为 98%。
  • 创建符合 conventional-commits 的消息。

• 确保一切正常

  • npm run fmt 来格式化您的代码。
  • npm run test:coverage 运行测试。

• 将更改推送到您的 fork。

• 创建一个 pull request。

  • 详细描述您的更改。
  • 如果适用，请引用任何相关问题。

代码审查

所有提交，包括项目成员的提交，都需要审查。 我们使用 GitHub pull requests 来实现此目的。 有关使用 pull requests 的更多信息，请查阅 GitHub 帮助。

许可证

该项目基于 Apache-2.0 许可证