跳至主要内容
版本: 最新版本 (v5.0.x)

为 Fastify 贡献

感谢您对为 Fastify 贡献表示兴趣。我们很高兴收到您的支持和知识。本指南旨在帮助您帮助我们。

注意​

这是一份非正式指南。请查看正式的 贡献文档 以获取完整详细信息以及我们的 开发者来源证书。

目录​

我们正在寻找的贡献类型​

简而言之，我们欢迎您提供的任何类型的贡献。没有哪种贡献太小。我们欣然接受以下方面的贡献

  • 文档改进：从小的错别字更正到主要的文档重写
  • 通过在拉取请求和 讨论 中回答问题来帮助他人
  • 修复 已知错误
  • 通过打开包含最小重现步骤的问题来报告以前未知的错误

基本规则和期望​

在我们开始之前，以下是一些我们对您的期望（以及您应该对其他人的期望）

  • 在围绕此项目的对话中保持尊重和体贴。该项目由来自全球各地的多元化人员维护。每个人对该项目都有自己的看法和意见。尝试倾听彼此的意见并达成协议或妥协。
  • 我们有 行为准则。您必须遵守它才能参与此项目。
  • 如果您打开了一个拉取请求，请确保您的贡献通过了所有测试。如果存在测试失败，您需要在我们可以合并您的贡献之前解决它们。

如何贡献​

如果您想贡献，请先搜索 问题 和 拉取请求，看看是否有人提出了类似的想法或问题。

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

  • **如果您的贡献很小，**例如更正错别字，请打开一个拉取请求。
  • **如果您的贡献很大，**例如新增功能，请先打开一个问题。这样，其他人就可以在您进行任何工作之前参与讨论。

设置您的环境​

请遵守项目的代码和文档风格。一些自动“更正”代码和文档的流行工具不遵循此项目使用的风格。值得注意的是，此项目使用 StandardJS 进行代码格式化。

Open in Gitpod

使用 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 返回类似以下内容

❯ 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 设置 选项将显示在下拉菜单中：工作区、默认和用户设置。我们建议选择默认。这将打开一个文档，其中包含编辑器的设置。将以下 JSON 粘贴到此文档中，覆盖任何已存在的文本，然后保存它

{
    "[javascript]": {
        "editor.defaultFormatter": "dbaeumer.vscode-eslint",
        "editor.codeActionsOnSave": {
            "source.fixAll": true
        }
    },

    "workbench.colorCustomizations": {
        "statusBar.background": "#178bb9"
    }
}

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

此时，您已全部设置了一个自定义 VSCode 实例，可用于处理 Fastify 贡献。当您编辑和保存 JavaScript 文件时，编辑器将自动更正任何样式问题。