参与 Fastify 开发

感谢您对贡献到 Fastify 感兴趣。我们很高兴收到您的支持和知识分享。本指南旨在帮助您更好地为我们提供帮助。

注意事项

这是一个非正式的指南。如需详细了解，请查阅正式的 CONTRIBUTING 文档以及我们的开发者贡献声明。

我们正在寻找的贡献类型

简而言之，我们欢迎任何类型的贡献。无论大小，我们都乐于接受各种形式的贡献，例如：

文档改进：从纠正小错误到重新编写整个文档
通过回答拉取请求中的问题以及在讨论中帮助他人
修复已知的 bug
报告之前未知的问题，通过打开一个包含最小复现步骤的新问题

基本规则与期望

在开始之前，这里有一些我们对你（以及其他人）的期望：

在围绕此项目的对话中，请保持尊重和思考。该项目由来自全球各地的一群多样化的人维护。每个人对项目都有自己的观点和意见。请尝试倾听彼此并达成一致或妥协。
我们有一份行为准则。您必须遵守它才能参与此项目。
如果你提交了一个拉取请求，请确保你的贡献通过了所有测试。如果有测试失败，你需要解决这些问题我们才能合并你的贡献。

如何贡献

如果你希望做出贡献，可以从搜索问题和拉取请求开始，看看是否有人提出了类似的想法或问题。

如果没有看到你的想法，并且你认为它符合本指南的目标，请执行以下操作之一：

如果你的贡献是小的，例如修复拼写错误，可以打开一个拉取请求。
如果你的贡献是大的，例如新功能，首先请先打开一个问题。这样其他人可以在你开始工作之前参与讨论。

设置开发环境

请遵循项目的代码和文档风格。一些流行的自动“修正”代码和文档的工具并不符合本项目的风格规范。特别地，该项目使用StandardJS 进行代码格式化。

使用 Visual Studio Code

以下是如何使用 Visual Studio Code (VSCode) 可移植版本创建特定于 Fastify 的开发环境。本指南假设您在 macOS 上设置该环境，但其原则适用于所有平台。请参阅之前链接的 VSCode 可移植指南以获取其他平台的帮助。

首先，下载 VSCode ，并将其解压到 /Applications/VSCodeFastify/ 目录下。执行以下命令后，在终端中运行应输出 “found”：


[ -d /Applications/VSCodeFastify/Visual\ Studio\ Code.app ] && echo "found"

如 VSCode 可移植指南所述，我们需要解除应用程序的沙箱限制以使可移植模式正常工作。因此，请在终端中执行以下命令：


xattr -dr com.apple.quarantine /Applications/VSCodeFastify/Visual\ Studio\ Code.app

接下来，为 VSCode 创建所需的目录：


mkdir -p /Applications/VSCodeFastify/code-portable-data/{user-data,extensions}

继续之前，我们需要将 code 命令添加到终端的 PATH 中。为此，我们将手动将 VSCode 添加到 PATH 。根据该文档中的说明，具体步骤取决于您的默认 shell，因此请遵循与您首选 shell 相关的指南。但是，我们需要稍作调整，定义一个别名而不是直接引用 code 工具。这样可以避免与其他安装的 VSCode 冲突，并使本指南专用于 Fastify。最终，我们希望实现以下内容：


alias code-fastify="/Applications/VSCodeFastify/Visual\ Studio\ Code.app/Contents/Resources/app/bin/code"



执行 `code-fastify --version` 命令后，结果应类似于：

```sh
❯ code-fastify --version
1.50.0
93c2f0fbf16c5a4b10e4d5f89737d9c2c25488a3
x64

现在 VSCode 已安装完毕，我们可以通过命令行对其进行操作。接下来需要安装一个扩展程序，以确保你为项目编写的任何 JavaScript 代码都符合项目的样式规范：


code-fastify --install-extension dbaeumer.vscode-eslint

成功执行上述命令后，以下命令应输出 “found”：


[ -d /Applications/VSCodeFastify/code-portable-data/extensions/dbaeumer.vscode-eslint-* ] && echo "found"

现在，在你本地克隆的 Fastify 项目的目录中，我们可以打开 VSCode：


code-fastify .

一个新的 VSCode 窗口应会打开，并且你应该在左侧边栏中看到 Fastify 项目文件。但是请注意！我们还没有完成。在 VSCode 准备就绪之前，还需要设置一些基本的配置。

按下 cmd+shift+p 打开 VSCode 命令输入提示框。键入 open settings (json)。下拉菜单中将出现三个 VSCode 设置选项：Workspace、Default 和 User settings。我们建议选择 Default。这将打开一个文档，其中包含编辑器的设置。将以下 JSON 贴入该文档，并覆盖任何已存在的文本，然后保存：


{
    "[javascript]": {
        "editor.defaultFormatter": "dbaeumer.vscode-eslint",
        "editor.codeActionsOnSave": {
            "source.fixAll": true
        }
    },
 
    "workbench.colorCustomizations": {
        "statusBar.background": "#178bb9"
    }
}

最后，从菜单栏中选择“Terminal > New Terminal”以在编辑器中打开一个新的终端。运行 npm i 以安装 Fastify 的依赖项。

此时，您已经设置好了一个自定义的 VSCode 实例，可用于进行 Fastify 贡献工作。当您编辑并保存 JavaScript 文件时，编辑器会自动修正任何样式问题。