FastAPI ヘルプ - ヘルプの取得¶
FastAPI は好きですか？
FastAPI、他のユーザー、そして作者を手伝いたいですか？
それとも FastAPI でヘルプが必要ですか？
手伝うための非常に簡単な方法があります（多くは 1 ～ 2 回のクリックで済みます）。
ヘルプを得るための方法もいくつかあります。
ニュースレターを購読する¶
（時々しか発行されない）FastAPI and friends ニュースレターを購読して、最新情報を入手できます。
- FastAPI とその仲間たちのニュース 🚀
- ガイド 📝
- 機能 ✨
- 破壊的変更 🚨
- ヒントとコツ ✅
X (Twitter) で FastAPI をフォローする¶
X (Twitter) で @fastapi をフォローして、FastAPI に関する最新情報を入手してください。🐦
GitHub で FastAPI にスターをつける¶
GitHub で FastAPI に「スターをつける」（右上にあるスターボタンをクリック）ことができます： https://github.com/fastapi/fastapi。⭐️
スターをつけることで、他のユーザーが FastAPI を見つけやすくなり、すでに他の人に役立っていることがわかります。
リリースについては GitHub リポジトリをウォッチする¶
GitHub で FastAPI を「ウォッチする」（右上にある「ウォッチ」ボタンをクリック）ことができます： https://github.com/fastapi/fastapi。👀
そこで「Releases only」（リリースのみ）を選択できます。
これにより、バグ修正や新機能を含む FastAPI の新しいリリース（新しいバージョン）があるたびに、通知（メール）が届くようになります。
作者に連絡する¶
作者である 私（Sebastián Ramírez / tiangolo） に連絡することができます。
あなたは
- GitHub で私をフォローする.
- 私が作成した他のオープンソースプロジェクトを見て、それが役に立つかもしれません。
- 私が新しいオープンソースプロジェクトを作成したときに通知を受け取るためにフォローしてください。
- X (Twitter) で私をフォローするか、Mastodon をフォローしてください。
- FastAPI をどのように使用しているか教えてください（聞くのが大好きです）。
- 私が発表したり、新しいツールをリリースしたりしたときに通知を受け取る。
- また、X (Twitter) で @fastapi をフォローすることもできます（別のアカウントです）。
- LinkedIn で私をフォローする.
- 私が発表したり、新しいツールをリリースしたりしたときに通知を受け取る（ただし、X (Twitter) の方が頻繁に使用しています 🤷♂）。
- Dev.to または Medium で私の書いたものを読む（または私をフォローする）。
- 他のアイデアや記事を読んだり、私が作成したツールについて読んだりしてください。
- 私が新しいものを公開したときに読むためにフォローしてください。
FastAPI についてツイートする¶
FastAPI についてツイートして、なぜ好きなのかを私や他の人に知らせてください。🎉
FastAPI がどのように使われているか、何が気に入ったか、どのプロジェクト/会社で使っているかなどを聞くのが大好きです。
FastAPI に投票する¶
GitHub での質問を他の人に手伝う¶
あなたができることは、質問に答えて他の人を手伝うことです。
多くの場合、あなたはすでにそれらの質問に対する答えを知っているでしょう。🤓
多くの人に質問で助けていると、公式の FastAPI Expert になれます。🎉
最も重要な点は、親切であるように努めることです。人々はフラストレーションを抱えてやってきて、多くの場合最良の方法で質問しませんが、できる限り親切にしてください。🤗
FastAPI コミュニティが親切で歓迎されるようにすることが目標です。同時に、他者へのいじめや無礼な行動は容認しないでください。お互いを大切にしなければなりません。
質問で他の人を助ける方法（ディスカッションまたはイシューにて）
質問を理解する¶
-
まず、質問している人の**目的**とユースケースを理解できるかどうかを確認します。
-
次に、質問（大多数は質問です）が**明確**かどうかを確認します。
-
多くの場合、質問はユーザーの想像上の解決策についてですが、**より良い**解決策があるかもしれません。問題とユースケースをよりよく理解できれば、より良い**代替解決策**を提案できるかもしれません。
-
質問が理解できない場合は、さらに**詳細**を尋ねてください。
問題を再現する¶
ほとんどの場合、質問は**元のコード**に関連しています。
多くの場合、コードの一部しかコピーされないかもしれませんが、それで**問題を再現**するには十分ではありません。
-
彼らに 最小限の再現可能な例 を提供するように依頼できます。これは、彼らが見ているのと同じエラーや動作を確認するために、またはユースケースをよりよく理解するために、ローカルで**コピー＆ペースト**して実行できます。
-
もし非常に寛大であれば、問題の説明だけで、自分で**例を作成**しようとすることができます。ただし、これには多くの時間がかかる可能性があることに留意してください。まず、問題を明確にするように依頼する方が良いかもしれません。
解決策を提案する¶
-
質問を理解できたら、彼らに可能な**回答**を提供できます。
-
多くの場合、彼らがやろうとしていることよりも良い解決方法があるかもしれないので、彼らの**根本的な問題やユースケース**を理解する方が良いです。
クローズを依頼する¶
彼らが返信した場合、あなたが問題を解決した可能性が高いです。おめでとうございます、**あなたはヒーローです**！🦸
-
さて、それで彼らの問題が解決した場合、彼らに依頼できます。
- GitHub Discussions では：コメントを**回答**としてマークする。
- GitHub Issues では：イシューを**クローズ**する。
GitHub リポジトリをウォッチする¶
GitHub で FastAPI を「ウォッチする」（右上にある「ウォッチ」ボタンをクリック）ことができます： https://github.com/fastapi/fastapi。👀
「Releases only」ではなく「Watching」を選択すると、誰かが新しいイシューや質問を作成したときに通知を受け取ります。新しいイシュー、ディスカッション、PRなどについてのみ通知を受け取るように指定することもできます。
そうすれば、それらを解決するために手伝うことができます。
質問をする¶
GitHub リポジトリで新しい質問を作成できます。例えば、
- **質問**をする、または**問題**について尋ねる。
- 新しい**機能**を提案する。
注意：もしそうした場合、あなたにも他の人を手伝ってもらうようにお願いします。😉
プルリクエストをレビューする¶
他の人からのプルリクエストをレビューするのを手伝うことができます。
繰り返しになりますが、親切であるよう最善を尽くしてください。🤗
プルリクエストをレビューする際に考慮すべきことと方法
問題を理解する¶
-
まず、プルリクエストが解決しようとしている**問題**を理解していることを確認します。GitHub Discussion または Issue でより長い議論があるかもしれません。
-
また、問題が**別の方法**で解決できるため、プルリクエストが実際には必要ない可能性も十分にあります。その場合、それを提案または質問できます。
スタイルは気にしないでください¶
-
コミットメッセージのスタイルなどのことにはあまりこだわらないでください。私が手動でコミットを編集して squash & merge します。
-
スタイルルールについても心配しないでください。それらをチェックする自動化されたツールがすでにあります。
そして、他のスタイルや一貫性の必要があれば、直接尋ねるか、必要な変更を伴うコミットを追加します。
コードを確認する¶
-
コードを確認して読み、意味が通るか確認し、**ローカルで実行**して、実際に問題が解決するかどうかを確認します。
-
そして、それを試したことを**コメント**で伝えてください。それが私があなたが実際に確認したことを知る方法です。
情報
残念ながら、承認がいくつかあるだけの PR を単純に信頼することはできません。
説明が魅力的であるため、3 つ、5 つ以上の承認がある PR がありましたが、PR を確認したところ、実際には壊れていたり、バグがあったり、主張している問題を解決していなかったりすることが何度もありました。😅
そのため、実際にコードを読んで実行し、コメントでそのことを知らせてもらうことが非常に重要です。🤓
- PR が簡略化できる場合、それを依頼できますが、あまりうるさく言う必要はありません。主観的な視点がたくさんある可能性があり（私も私自身の視点を持っています 🙈）、そのため、基本的なことに焦点を当てるのが良いでしょう。
テスト¶
-
PR に**テスト**があるか確認するのを手伝ってください。
-
PR を実行する前にテストが**失敗**することを確認してください。🚨
-
PR を実行した後にテストが**パス**することを確認してください。✅
-
多くの PR にはテストがありません。テストを追加するように**リマインド**したり、自分でテストを**提案**することもできます。これは多くの時間を消費するものの 1 つであり、あなたはそれで大いに助けることができます。
-
そして、試したことをコメントしてください。そうすれば、あなたが確認したことがわかります。🤓
プルリクエストを作成する¶
たとえば、プルリクエストでソースコードに貢献できます。
- ドキュメントで見つけたタイポを修正する。
- FastAPI に関する記事、ビデオ、またはポッドキャストを作成または発見した場合は、このファイルを編集して共有する。
- リンクを対応するセクションの先頭に追加してください。
- ドキュメントをあなたの言語に翻訳するのを手伝う。
- 他の人が作成した翻訳をレビューするのを手伝うこともできます。
- 新しいドキュメントセクションを提案する。
- 既存のイシュー/バグを修正する。
- テストを追加することを忘れないでください。
- 新しい機能を追加する。
- テストを追加することを忘れないでください。
- 関連する場合はドキュメントを追加することを忘れないでください。
FastAPI のメンテナンスを手伝う¶
FastAPI のメンテナンスを手伝ってください！🤓
やるべきことはたくさんあり、そのほとんどは**あなた**ができます。
今すぐできる主なタスクは次のとおりです。
- GitHub での質問を他の人に手伝う（上記のセクションを参照）。
- プルリクエストをレビューする（上記のセクションを参照）。
これら 2 つのタスクは、**最も時間を消費する**ものです。それが FastAPI のメンテナンスの主な作業です。
それらに協力してくれるなら、**FastAPI のメンテナンスを手伝っている**ことになり、FastAPI が**より速く、より良く進歩し続ける**ことを保証することになります。🚀
チャットに参加する¶
👥 Discord チャットサーバー 👥 に参加して、FastAPI コミュニティの他の人たちと交流しましょう。
ヒント
質問については、GitHub Discussions で質問してください。 FastAPI Experts からヘルプを得られる可能性がはるかに高くなります。
チャットは、その他の一般的な会話にのみ使用してください。
質問にはチャットを使用しない¶
チャットはより「自由な会話」を可能にするため、あまりにも一般的な質問をしやすいこと、そして答えるのが難しいことを覚えておいてください。そのため、回答が得られないかもしれません。
GitHub では、テンプレートが適切な質問を書くのに役立ち、質問する前に問題を解決できる可能性もあります。また、GitHub では、たとえ時間がかかっても、すべてに必ず回答することを保証できます。チャットシステムでは個人的にそれができません。😅
チャットシステムでの会話は、GitHub よりも検索が難しく、質問や回答が会話の中に埋もれてしまう可能性があります。また、FastAPI Expert になるためには GitHub でのやり取りのみがカウントされるため、GitHub の方がより注目される可能性が高いでしょう。
一方で、チャットシステムには数千人のユーザーがいるため、ほぼいつでも誰かと話せる可能性が高いです。😄
作者にスポンサーをする¶
あなたの**製品/会社**が FastAPI に依存している、または関連しており、そのユーザーにリーチしたい場合は、GitHub sponsors を通じて作者（私）にスポンサーすることができます。ティアによっては、ドキュメントのバッジなどの追加特典が得られる場合があります。🎁
ありがとう！🚀