コンテンツへスキップ

SQLModel ヘルプ - ヘルプの入手方法

**SQLModel** を気に入っていますか？

SQLModel、他のユーザー、そして作者を助けたいですか？

または、**SQLModel** のヘルプを得たいですか？

非常に簡単な方法で貢献できます（いくつかの方法はワンクリックかツークリックです）。

そして、ヘルプを得るためのいくつかの方法もあります。

FastAPI and Friends ニュースレターを購読する

あなたは（頻度の低い）**FastAPI and friends ニュースレター** を購読して、以下の最新情報を得ることができます。

  • SQLModel 🚀を含む、FastAPIとその仲間に関するニュース
  • ガイド 📝
  • 機能 ✨
  • 破壊的変更 🚨
  • ヒントとコツ ✅

GitHub で **SQLModel** にスターをつける

GitHub で SQLModel に「スター」をつけることができます（右上のスターボタンをクリック）： https://github.com/tiangolo/sqlmodel。 ⭐️

スターを追加することで、他のユーザーはより簡単にそれを見つけることができ、すでに他の人にとって役に立っていることがわかります。

リリースのために GitHub リポジトリをウォッチする

GitHub で SQLModel を「ウォッチ」することができます（右上の「ウォッチ」ボタンをクリック）： https://github.com/tiangolo/sqlmodel。 👀

そこで「リリースのみ」を選択できます。

これを行うことで、バグ修正と新機能を含む **SQLModel** の新しいリリース（新しいバージョン）があるたびに、（メールで）通知を受け取ります。

作者とつながる

作者である 私（Sebastián Ramírez / `tiangolo`） とつながることができます。

あなたはできます

  • **GitHub** でフォローする.
    • 私が作成した、あなたを助けることができる他のオープンソースプロジェクトをご覧ください。
    • 新しいオープンソースプロジェクトを作成したときに通知を受け取ります。
  • **Twitter** でフォローする.
    • SQLModel の使用方法を教えてください（ぜひお聞かせください）。
    • 発表や新しいツールのリリース時に通知を受け取ります。
  • **Linkedin** でつながる.
    • 発表や新しいツールのリリース時に通知を受け取ります（ただし、私は Twitter をもっと頻繁に使用しています 🤷‍♂）。
  • **Dev.to** または **Medium** で私が書いたものを読む（または私をフォローする）。
    • 他のアイデア、記事、そして私が作成したツールについて読んでください。
    • 新しいものを公開したときに読むためにフォローしてください。

**SQLModel** についてツイートする

**SQLModel** についてツイートすることで、気に入っている理由を私や他の人々に知らせてください。 🎉

**SQLModel** がどのように使用されているか、何が気に入っているか、どのプロジェクト/会社で使用しているかなどを知りたいと思っています。

GitHub で質問に答えて他の人を助ける

GitHub の

多くの場合、あなたはすでにそれらの質問に対する答えを知っているかもしれません。 🤓

覚えておいてください、最も重要な点は：親切にしてください。人々は不満を抱えてやってきて、多くの場合、最善の方法で質問をしません。しかし、できる限り親切にしてください。 🤗

**SQLModel** コミュニティが親切で歓迎的なものであることが重要です。同時に、他者に対するいじめや無礼な行為は受け入れません。私たちは互いに気を配らなければなりません。

質問に答える方法（ディスカッションまたはIssueで）

質問を理解する

  • 質問者の**目的**とユースケースを理解できるかどうかを確認してください。

  • 次に、質問（ほとんどの場合、質問です）が**明確**かどうかを確認します。

  • 多くの場合、質問はユーザーの想像上の解決策に関するものですが、**より良い**解決策があるかもしれません。問題とユースケースをよりよく理解できれば、より良い**代替ソリューション**を提案できる可能性があります。

  • 質問が理解できない場合は、詳細を要求してください。

問題を再現する

ほとんどの場合、ほとんどの質問には、質問者の**元のコード**に関連する何かがあります。

多くの場合、彼らはコードの一部分だけをコピーしますが、それは**問題を再現する**には十分ではありません。

  • あなたは彼らに最小限の再現可能な例を提供するように求めることができます。あなたはそれを**コピー＆ペースト**してローカルで実行し、彼らが見ているのと同じエラーや動作を確認したり、彼らのユースケースをよりよく理解することができます。

  • 寛大すぎる場合は、問題の説明に基づいて自分でそのような例を作成しようとすることができます。ただし、これは多くの時間がかかる可能性があり、最初に問題を明確にするように依頼する方が良い場合があります。

解決策を提案する

  • 質問を理解したら、可能な**回答**を与えることができます。

  • 多くの場合、彼らの**根本的な問題やユースケース**を理解する方が良いでしょう。なぜなら、彼らがしようとしていることよりも、それを解決するより良い方法があるかもしれません。

クローズを依頼する

彼らが返信した場合、彼らの問題を解決した可能性が高いです。おめでとうございます、**あなたはヒーローです**！ 🦸

  • これで問題が解決したら、

    • GitHub ディスカッションでは、コメントを**回答**としてマークします。
    • GitHub Issuesでは、**Issueをクローズ**します。

GitHub リポジトリをウォッチする

GitHub で SQLModel を「ウォッチ」することができます（右上の「ウォッチ」ボタンをクリック）： https://github.com/tiangolo/sqlmodel。 👀

「リリースのみ」ではなく「ウォッチ」を選択すると、誰かが新しいIssueや質問を作成したときに通知を受け取ります。新しいIssue、ディスカッション、PRなどについてのみ通知を受け取るように指定することもできます。

それから、それらの質問を解決するのを手伝うことができます。

質問をする

たとえば、GitHub リポジトリで新しい質問を作成することができます。

  • **質問**をするか、**問題**について尋ねます。
  • 新しい**機能**を提案します。

**注記**：そうした場合、私も他の人を助けてもらうようにお願いするでしょう。 😉

プルリクエストを確認する

他の人からのプルリクエストを確認するお手伝いをすることができます。

重ねてお願いですが、できる限り親切にしてください。 🤗

プルリクエストのレビュー方法と留意点

問題の理解

  • まず、プルリクエストが解決しようとしている問題を理解してください。GitHubのディスカッションやIssueに詳しい説明があるかもしれません。

  • また、問題が別の方法で解決できるため、実際にはプルリクエストが不要な場合もあります。その場合は、提案したり、質問したりしてください。

スタイルは気にしないでください

  • コミットメッセージのスタイルなどはあまり気にしないでください。手動でコミットを調整してsquash and mergeします。

  • スタイルルールについても心配しないでください。既に自動化されたツールでチェックされています。

その他、スタイルや整合性に関する必要性があれば、直接依頼するか、必要な変更を加えたコミットを追加します。

コードの確認

  • コードを確認して読んで、意味が通じるかどうかを確認し、ローカルで実行して、実際に問題が解決されるかどうかを確認してください。

  • その後、確認したことをコメントで記述してください。そうすることで、実際に確認したことが分かります。

情報

残念ながら、承認が複数あるPRを単純に信用することはできません。

説明が魅力的なため、3つ、5つ、またはそれ以上の承認が付いたPRが実際には壊れていたり、バグがあったり、解決しようとしている問題を解決していなかったりすることが何度かありました。😅

そのため、実際にコードを読んで実行し、コメントでその旨を知らせていただくことが非常に重要です。🤓

  • PRを簡素化できる場合は、そのように依頼できますが、あまり神経質になる必要はありません。主観的な見解が多くある可能性があります（私も同様です🙈）。そのため、基本的なことに集中した方が良いでしょう。

テスト

  • PRにテストがあるかどうかを確認するお手伝いをお願いします。

  • PR前にはテストが失敗することを確認してください。🚨

  • そして、PR後にはテストが成功することを確認してください。✅

  • 多くのPRにはテストがありません。テストを追加するよう注意喚起したり、自分でテストを提案したりすることもできます。これは最も時間を消費する作業の1つであり、その点で大きく貢献できます。

  • そして、試したことをコメントしてください。そうすれば、確認したことが分かります。🤓

プルリクエストの作成

例えば、プルリクエストでソースコードに貢献できます。

  • ドキュメントで見つけたタイプミスを修正する場合。
  • 新しいドキュメントセクションを提案する場合。
  • 既存の問題/バグを修正する場合。
    • テストを追加するようにしてください。
  • 新しい機能を追加する場合。
    • テストを追加するようにしてください。
    • 関連する場合は、ドキュメントを追加してください。

SQLModelの維持のお手伝い

SQLModelの維持のお手伝いをお願いします！🤓

やるべきことがたくさんあり、そのほとんどをあなたが行うことができます。

現在できる主なタスクは次のとおりです。

これら2つのタスクは最も時間を消費する作業です。これはSQLModelを維持する主な作業です。

これらのお手伝いをしていただければ、SQLModelの維持に貢献し、より迅速かつ優れた発展を確実にします。🚀

チャットへの参加

👥 FastAPI and Friends Discordチャットサーバー 👥に参加して、コミュニティの他のメンバーと交流しましょう。#sqlmodelチャンネルがあります。

ヒント

質問はGitHubディスカッションで質問してください。そこでヘルプを受けられる可能性がはるかに高くなります。

チャットはその他の一般的な会話にのみ使用してください。

チャットで質問しないでください

チャットではより「自由な会話」が可能になるため、あまりにも一般的な、答えにくい質問をしやすいため、回答が得られない可能性があります。

GitHubでは、テンプレートが適切な質問の作成をガイドしてくれるため、より簡単に適切な回答を得たり、質問する前に自分で問題を解決したりすることができます。GitHubでは、時間がかかっても、常にすべてに回答するように努めます。チャットでは、個人的にそれを行うことはできません。😅

チャットでの会話は、GitHubのように簡単に検索できるわけではないため、質問と回答が会話の中で失われる可能性があります。

一方、チャットには何千人ものユーザーがいるため、ほぼ常に話せる相手が見つかる可能性が高いです。😄

GitHubスポンサーを通じて、作成者（私）を経済的に支援することもできます。

そこで、感謝の気持ちとしてコーヒー☕️をご購入いただけます。😄

ドキュメントで見たように、SQLModelはPydanticとSQLAlchemyという巨人の肩の上に立っています。

また、スポンサーになることができます。

ありがとうございます！🚀