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