贡献指南
这是所有 AdonisJS 仓库的通用贡献指南。在为任何仓库做贡献之前，请仔细阅读本指南 🙏
代码不是唯一的贡献方式。以下也是一些贡献和成为社区一员的方式。
- 修复文档中的错别字
- 改进现有文档
- 撰写 cookbook 或博客文章以教育社区中的其他人
- 问题分类
- 在现有问题上分享你的意见
- 在 Discord 和讨论论坛中帮助社区。
报告错误
在开源项目中报告的许多问题通常是报告者端的问题或配置错误。因此，我们强烈建议你在报告问题之前正确排除故障。
如果你要报告错误，请尽可能多地包含信息以及你编写的代码示例。好问题到坏问题的等级如下。
完美问题：你隔离了底层错误。在仓库中创建一个失败的测试，并围绕它打开一个 Github issue。
良好问题：你隔离了底层错误，并提供了一个最小复现作为 Github 仓库。Antfu 写了一篇很棒的文章 为什么需要复现。
一般问题：你正确陈述了你的问题。分享首先产生问题的代码。还包括相关的配置文件和你使用的包版本。
最后但同样重要的是，按照 Github markdown 语法指南 正确格式化每个代码块。
差问题：你只是把你的问题扔出来，希望其他人会问相关问题并帮助你。这类问题会在没有任何解释的情况下自动关闭。
进行讨论
你经常想讨论一个话题或分享一些想法。在这种情况下，在讨论论坛的 💡Ideas 类别下创建一个讨论。
教育他人
教育他人是为任何社区做贡献并获得认可的最佳方式之一。
你可以使用我们讨论论坛上的 📚 Cookbooks 类别与他人分享文章。cookbooks 部分不会严格审核，但分享的知识应该与项目相关。
创建 Pull Request
在投入大量时间和精力编写代码后，如果你的 pull request 被拒绝，这绝不是一个好的体验。因此，我们强烈建议你在开始任何新工作之前发起讨论。
只需开始讨论并解释你打算贡献什么？
你是否试图创建 PR 来修复错误：一旦错误得到确认，修复错误的 PR 通常会被接受。
你是否计划添加新功能：请彻底解释为什么需要此功能，并分享我们可以阅读的学习材料的链接以自我教育。
例如：如果你要为 Japa 或 AdonisJS 添加快照测试支持。那么分享我可以用来了解更多关于快照测试的链接。
注意：你还应该可以打开额外的 PR 来记录贡献的功能或改进。
仓库设置
首先在你的本地机器上克隆仓库。
shgit clone <REPO_URL>在本地安装依赖项。请不要随功能请求一起更新任何依赖项。如果你发现过时的依赖项，请创建一个单独的 PR 来更新它们。
我们使用
npm来管理依赖项，因此不要使用yarn或任何其他工具。shnpm install通过执行以下命令运行测试。
shnpm test
使用的工具
以下是使用的工具列表。
| 工具 | 用途 |
|---|---|
| TypeScript | 所有仓库都用 TypeScript 编写。编译后的 JavaScript 和类型定义发布在 npm 上。 |
| TS Node | 我们使用 ts-node 来运行测试或脚本而无需编译 TypeScript。ts-node 的主要目标是在开发过程中获得更快的反馈循环 |
| SWC | SWC 是基于 Rust 的 TypeScript 编译器。TS Node 自带使用 SWC 而非 TypeScript 官方编译器的一流支持。使用 SWC 的主要原因是速度提升。 |
| Release-It | 我们使用 release-it 在 npm 上发布我们的包。它完成创建发布并在 npm 和 Github 上发布的所有繁重工作。它的配置在 package.json 文件中定义。 |
| ESLint | ESLint 帮助我们在所有有多个贡献者的仓库中强制执行一致的编码风格。我们所有的 ESLint 规则都发布在 eslint-plugin-adonis 包下。 |
| Prettier | 我们使用 prettier 格式化代码库以获得一致的视觉输出。如果你困惑我们为什么同时使用 ESLint 和 Prettier，请阅读 Prettier 网站上的 Prettier vs. Linters 文档。 |
| EditorConfig | 每个项目根目录中的 .editorconfig 文件配置你的代码编辑器使用一组缩进和空白管理规则。再次强调，Prettier 用于后期格式化你的代码，EditorConfig 用于提前配置编辑器。 |
| Conventional Changelog | 所有仓库的所有提交都使用 commitlint 来强制执行一致的提交消息。 |
| Husky | 我们使用 husky 在提交代码时强制执行提交约定。Husky 是用 Node 编写的 git hooks 系统 |
命令
| 命令 | 描述 |
|---|---|
npm run test | 使用 ts-node 运行项目测试 |
npm run compile | 将 TypeScript 项目编译为 JavaScript。编译输出写入 build 目录 |
npm run release | 使用 np 启动发布过程 |
npm run lint | 使用 ESlint 检查代码库 |
npm run format | 使用 Prettier 格式化代码库 |
npm run sync-labels | 将 .github/labels.json 文件中定义的标签与 Github 同步。此命令仅供项目管理员使用。 |
编码风格
我们所有的项目都用 TypeScript 编写，正在转向纯 ESM。
另外，确保在推送代码之前运行以下命令。
# 使用 prettier 格式化
npm run format
# 使用 Eslint 检查
npm run lint被认可为贡献者
我们依靠 GitHub 在仓库右侧面板列出所有仓库贡献者。以下是一个示例。
此外，我们使用 Github 的自动生成发布说明功能，它在发布说明中添加对贡献者资料的引用。