ヘルプ タイパー - ヘルプの取得
**Typer**がお気に召しましたか?
Typer、他のユーザー、そして作者を助けたいですか?
それとも、**Typer**に関するヘルプが必要ですか?
非常に簡単な方法で協力できます(いくつかは1回または2回のクリックだけで済みます)。
そして、ヘルプを得るためのいくつかの方法もあります。
ニュースレターを購読する¶
あなたは(頻度は低いですが)FastAPI and friends ニュースレターを購読して、以下に関する最新情報を得ることができます。
- FastAPIと仲間たち、そしてTyper 🚀に関するニュース
- ガイド 📝
- 機能 ✨
- 破壊的変更 🚨
- ヒントとコツ ✅
GitHubで**Typer**にスターをつけよう¶
GitHubでTyperに「スター」をつけることができます(右上のスターボタンをクリックしてください):https://github.com/tiangolo/typer。
スターを追加することで、他のユーザーがより簡単にTyperを見つけることができ、既に他の人にとって役に立っていることがわかります。
GitHubリポジトリでリリースをウォッチする¶
GitHubでTyperを「ウォッチ」することができます(右上の「ウォッチ」ボタンをクリックしてください):https://github.com/tiangolo/typer。
そこで「リリースのみ」を選択できます。
これを行うことで、バグ修正と新機能を含む**Typer**の新しいリリース(新しいバージョン)があるたびに、通知(メールで)を受け取ります。
作者とつながる¶
作者である私(Sebastián Ramírez / tiangolo
)とつながることができます。
あなたはできます
- GitHubで私をフォローする.
- 私が作成した他のオープンソースプロジェクトを参照できます。
- 新しいオープンソースプロジェクトを作成したときに通知を受け取ることができます。
- Twitterで私をフォローする.
- Typerの使用方法を教えてください(お聞きするのが大好きです)。
- 発表や新しいツールのリリース時に通知を受け取ることができます。
- Linkedinで私とつながる.
- 発表や新しいツールのリリース時に通知を受け取ることができます(ただし、Twitterの方が頻繁に使用しています 🤷♂)。
- Dev.toまたはMediumで私が書いたものを読む(または私をフォローする)。
- 他のアイデア、記事、そして私が作成したツールについて読むことができます。
- 新しいものを公開したときに通知を受け取ることができます。
**Typer**についてツイートする¶
**Typer**についてツイートすることで、Typerの良い点について私や他の人々に知らせることができます。
**Typer**がどのように使用されているか、何が気に入っているか、どのプロジェクト/会社で使用しているかなど、お聞きするのが大好きです。
GitHubで質問に答えて他者を助ける¶
あなたは以下で他者の質問に答え、助けることができます。
多くの場合、あなたは既にそれらの質問への答えを知っているかもしれません。🤓
覚えておいてください、最も重要な点は:親切であることです。人々は不満を抱いてやってくることが多く、最善の方法で質問をしていない場合がありますが、できる限り親切にしてください。🤗
**Typer**コミュニティは親切で歓迎的なものであるべきです。同時に、いじめや他者に対する失礼な行動は許容しません。私たちは互いに気を配らなければなりません。
以下は、質問に答えて他者を助ける方法です(ディスカッションまたはIssuesで)。
質問を理解する¶
-
質問している人の**目的**とユースケースを理解できるかどうかを確認してください。
-
次に、質問(ほとんどが質問です)が**明確**かどうかを確認してください。
-
多くの場合、質問されたことはユーザーの想像上の解決策に関するものですが、**より良い**解決策があるかもしれません。問題とユースケースをよりよく理解できれば、より良い**代替ソリューション**を提案できる可能性があります。
-
質問が理解できない場合は、より多くの**詳細**を求めてください。
問題を再現する¶
ほとんどの場合、ほとんどの質問には、その人の**元のコード**に関連する何かがあります。
多くの場合、彼らはコードの一部だけをコピーしますが、それは**問題を再現する**には十分ではありません。
-
あなたは彼らに最小限で再現可能な例を提供するように求めることができます。これにより、あなたは**コピー&ペースト**してローカルで実行し、彼らが見ているのと同じエラーや動作を確認したり、彼らのユースケースをよりよく理解したりすることができます。
-
あなたが非常に寛大だと感じているなら、問題の説明に基づいて、自分でそのような**例を作成する**こともできます。ただし、これは多くの時間を要する可能性があり、最初に問題を明確化することを求める方が良い場合もあることに注意してください。
解決策を提案する¶
-
質問を理解できれば、彼らに可能な**回答**を与えることができます。
-
多くの場合、彼らの**根本的な問題やユースケース**を理解する方が良いでしょう。なぜなら、彼らがしようとしていることよりも、それを解決するより良い方法があるかもしれないからです。
クローズを依頼する¶
彼らが返信した場合、あなたは彼らの問題を解決した可能性が高いです。おめでとうございます、**あなたはヒーローです**!🦸
-
これで問題が解決した場合は、彼らに以下のことを依頼できます。
- GitHubディスカッションでは、コメントを**回答**としてマークします。
- GitHub Issuesでは、**Issueをクローズ**します。
GitHubリポジトリをウォッチする¶
GitHubでTyperを「ウォッチ」することができます(右上の「ウォッチ」ボタンをクリックしてください):https://github.com/tiangolo/typer。
「リリースのみ」ではなく「ウォッチ」を選択すると、誰かが新しいIssueまたは質問を作成したときに通知を受け取ります。新しいIssue、ディスカッション、PRなどについてのみ通知を受け取るように指定することもできます。
その後、それらの質問を解決するために協力することができます。
質問をする¶
あなたはGitHubリポジトリに新しい質問を作成することができます。例えば、
- **質問**をするか、**問題**について尋ねる。
- 新しい**機能**を提案する。
**注記**:もしそうするなら、私も他の人を助けるように頼むつもりです。😉
プルリクエストを確認する¶
他の人が作成したプルリクエストのレビューを手伝っていただけます。
繰り返しますが、できる限り親切にしてください 🤗
プルリクエストのレビュー方法と留意事項
問題の理解¶
-
まず、プルリクエストが解決しようとしている**問題を理解**してください。GitHubのディスカッションやissueでより詳細な議論が行われている場合があります。
-
また、問題を**別の方法**で解決できるため、実際にはプルリクエストが不要な場合もあります。その場合は、それを提案するか、質問してください。
スタイルを気にする必要はありません¶
-
コミットメッセージのスタイルなどはあまり気にしないでください。手動でコミットを調整してsquash and mergeします。
-
スタイルルールについても心配する必要はありません。既に自動化されたツールでチェックされています。
その他スタイルや整合性に関する必要がある場合は、直接依頼するか、必要な変更を加えたコミットを追加します。
コードの確認¶
-
コードを確認し、読んで、意味が通じるかどうかを確認し、**ローカルで実行**して、実際に問題が解決されるかどうかを確認してください。
-
その後、行ったことをコメントしてください。そうすれば、実際に確認したことが分かります。
情報
残念ながら、承認が複数あるPRを単純に信用することはできません。
説明が魅力的であるため、3つ、5つ、またはそれ以上の承認が付いているPRがいくつかありましたが、確認すると、実際には壊れていたり、バグがあったり、解決しようとしている問題を解決していなかったりすることが何度かありました 😅
そのため、実際にコードを読んで実行し、コメントでその旨を知らせていただくことが非常に重要です 🤓
- PRを簡素化できる方法があれば、それを求めることができますが、あまり細かいところまでこだわる必要はありません。主観的な見解はたくさんある可能性があり(私もそうです🙈)、基本的なことに集中する方が良いでしょう。
テスト¶
-
PRに**テスト**があることを確認するお手伝いをしてください。
-
PR前にはテストが**失敗**することを確認してください。🚨
-
次に、PR後にはテストが**成功**することを確認してください。✅
-
多くのPRにはテストがありません。テストを追加するよう**思い出させたり**、自分でテストを**提案**したりすることもできます。これは最も時間を消費する作業の1つであり、そこで大いに役立ちます。
-
その後、試したことをコメントしてください。そうすれば、確認したことが分かります 🤓
プルリクエストの作成¶
例えば、プルリクエストでソースコードに貢献**できます。
- ドキュメントで見つけたタイプミスを修正するため。
- 新しいドキュメントセクションを提案するため。
- 既存の問題/バグを修正するため。
- テストを追加してください。
- 新しい機能を追加するため。
- テストを追加してください。
- 関連する場合は、ドキュメントを追加してください。
Typerのメンテナンスのお手伝い¶
**Typer**のメンテナンスのお手伝いをお願いします!🤓
やるべきことはたくさんあり、そのほとんどを**あなた**が実行できます。
現在できる主なタスクは次のとおりです。
- GitHubで他の人々の質問に答える(上記のセクションを参照)。
- プルリクエストのレビュー(上記のセクションを参照)。
これら2つのタスクは**最も時間を消費する作業**です。Typerのメンテナンスの主な作業です。
それらを手伝っていただければ、**Typerのメンテナンスを支援**し、**より速く、より良い進化**を確実にします 🚀
チャットへの参加¶
👥 FastAPI and Friends Discordチャットサーバー 👥に参加して、コミュニティの他のメンバーと交流しましょう。#typer
チャンネルがあります。
チャットで質問しないでください¶
チャットではより「自由な会話」が可能になるため、あまりにも一般的な、答えにくい質問をしやすいため、回答が得られない可能性があります。
GitHubでは、テンプレートが適切な質問の作成をガイドするため、より簡単に適切な回答を得たり、質問する前に自分で問題を解決したりできます。GitHubでは、時間がかかっても、必ずすべてに回答します。チャットでは個人的にはそれはできません 😅
チャットでの会話はGitHubほど検索しやすくないため、質問と回答が会話の中で失われる可能性があります。
一方で、チャットには何千人ものユーザーがいるため、ほとんどの場合、話す相手を見つける可能性が高くなります 😄
作成者のスポンサーになる¶
GitHub sponsorsを通じて、作成者(私)を経済的に支援することもできます。
そこで、感謝の気持ちを込めてコーヒー☕️をご購入いただけます 😄
Typerを支えるツールのスポンサーになる¶
ドキュメントで見たように、TyperはClickの上に構築されています。
また、スポンサーになることもできます。
- Pallets Project(Clickのメンテナー)PSF経由またはTidelift経由
ありがとうございました!🚀