为 Radashi 做贡献

感谢你投入时间为 Radashi 做出贡献。

请注意，本文档介绍了如何通过 Fork Radashi 来进行贡献。如果你想通过 Radashi 模板进行贡献，请查看此页面。

有问题吗？

如果你对 Radashi 有一般性问题，例如如何使用它、路线图，或者有想法想讨论，可以在讨论区提问。提问前，请先搜索是否有人问过类似问题。如果不存在相关主题，你可以开始一个新的讨论。

遇到问题了吗？

如果你在使用 Radashi 时遇到问题、想报告错误或需要改进，可以在问题页面创建问题。创建前，请先搜索是否已有类似问题。如果不存在类似问题，你可以创建一个新的。

想贡献代码？

在添加新功能或特性之前，请先阅读我们的设计原则。如果只是修复现有代码，可以跳过这一步。

浏览现有问题找到你感兴趣的内容。一般来说，我们不会将问题指定给任何人。如果你找到要处理的问题，欢迎提交包含修复的 PR。在开始之前，你可以在问题的评论中自由询问有关实现或设计的问题。

准备编写代码？

• 开始前，在项目根目录运行 pnpm i 来安装依赖。
• 你可以使用 pnpm add-function <组名>/<函数名> 添加新函数。这将创建必要的文件并为新函数开启一个 PR。请尽量使用已存在的 组名（检查 src 目录）。注意，你需要手动从 src/mod.ts 导出函数后才能使用它。
• 你可以使用 pnpm test 运行单元测试。测试需要 Node v16+。你可以在根目录运行 nvm use 切换到正确的 Node 版本。要求测试通过且代码覆盖率达到 100%。
• 你可以使用 pnpm lint 检查代码，使用 pnpm format 格式化代码。在提交拉取请求前，这两项都需要完成。
• 为了熟悉现有代码，建议同时阅读文档和代码库。对于文档中的每个函数，在源代码中找到其实现并浏览代码。

准备推送更改？

在 Radashi 仓库的 Fork 上完成更改后，向 radashi 仓库的 main 分支创建拉取请求。如果你进行了破坏性变更，请改为以 next 分支为目标。

• 确保填写描述，让读者和审阅者理解你更改的实现和意图。
• 如果你在解决问题，别忘了将 PR 链接到问题。
• 启用复选框以允许维护者编辑，以便可以更新分支以进行合并。
• 记住要创建一个新分支来存放你的更改，而不是在 PR 中使用你 Fork 的 main 分支。使用 main 分支可能会导致问题。

提交 PR 后，Radashi 的维护者之一将会进行审查。他们可能会提出问题或要求提供更多信息。

你的 PR 被合并了！

恭喜！🥳

Radashi 的稳定版本是手动发布的。测试版是自动发布的，每天 UTC 时间凌晨 5:00（如果已有 PR 被合并）。当你的 PR 包含在测试版发布中时，会有一条评论更新你的 PR。