バージョン: latest (v5.0.x)

Fastifyへの貢献

Fastifyへの貢献に関心をお寄せいただき、ありがとうございます。皆様のサポートと知識を歓迎します。このガイドは、皆様が私たちを支援するための手助けとなることを目指しています。

注
これは非公式なガイドです。詳細および正式なCONTRIBUTINGドキュメントと、開発者証明書をご確認ください。

求めている貢献の種類

要するに、提供いただけるあらゆる種類の貢献を歓迎します。どんな貢献も小さすぎるということはありません。以下のような貢献を喜んで受け入れます。

ドキュメントの改善：小さなタイプミス修正から、ドキュメントの大幅な修正まで
プルリクエストやディスカッションで質問に答えて他の人を助ける
既知のバグを修正する
最小限の再現で問題を提起して、以前は知られていなかったバグを報告する

基本ルールと期待

始める前に、あなたに期待すること（そして他の人から期待されるべきこと）をいくつか示します。

このプロジェクトに関する会話では、敬意を払い、思慮深く行動してください。このプロジェクトは、世界中の多様な人々によって維持されています。各人は、プロジェクトに関する独自の視点と意見を持っています。互いに耳を傾け、合意または妥協点に達するように努めてください。
行動規範があります。このプロジェクトに参加するには、これを遵守する必要があります。
プルリクエストを開く場合は、貢献がすべてのテストに合格していることを確認してください。テストが失敗した場合は、貢献をマージする前にそれに対処する必要があります。

貢献方法

貢献したい場合は、まずissueとプルリクエストを検索して、他の誰かが同様のアイデアや質問を提起しているかどうかを確認してください。

アイデアがリストされておらず、このガイドの目標に合致すると思う場合は、次のいずれかを行います。

貢献が軽微な場合（タイプミスの修正など）、プルリクエストを開きます。
貢献が大きな場合（新機能など）、最初にissueを開いて開始します。そうすることで、作業を行う前に他の人が議論に参加できます。

環境設定

プロジェクトのコードとドキュメントのスタイルを遵守してください。コードとドキュメントを自動的に「修正」する一部の一般的なツールは、このプロジェクトで使用するスタイルに準拠したスタイルに従っていません。特に、このプロジェクトではコードフォーマットにStandardJSを使用しています。

Visual Studio Codeの使用

以下は、Fastify固有の環境を作成するためにVisual Studio Code（VSCode）ポータブル版を使用する方法です。このガイドは、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}

続行する前に、ターミナルのPATHにcodeコマンドを追加する必要があります。これを行うために、VSCodeをPATHに手動で追加します。そのドキュメントに概説されているように、指示はデフォルトのシェルによって異なるため、優先するシェルに関連するそのガイドの指示に従う必要があります。ただし、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)と入力します。Workspace、Default、Userの3つのVSCode設定オプションがドロップダウンに表示されます。Defaultを選択することをお勧めします。これにより、エディターの設定であるドキュメントが開きます。このドキュメントに次のJSONを貼り付け、既存のテキストを上書きして保存します。

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

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

最後に、メニューバーから「Terminal > New Terminal」を選択して、エディターに新しいターミナルを開きます。npm iを実行して、Fastifyの依存関係をインストールします。

この時点で、Fastifyの貢献に使用できるカスタムVSCodeインスタンスのセットアップはすべて完了です。JavaScriptファイルを編集して保存すると、エディターがスタイルの問題を自動修正します。

Fastifyへの貢献

注​

目次​

求めている貢献の種類​

基本ルールと期待​

貢献方法​

環境設定​

Visual Studio Codeの使用​

注

目次

求めている貢献の種類

基本ルールと期待

貢献方法

環境設定

Visual Studio Codeの使用