AIでコミュニティヘルスファイルを更新する方法

GitHub Copilotの機能の詳細については、ドキュメントをお読みいただくか、今すぐご利用ください。

QUERY LENGTH LIMIT EXCEEDED. MAX ALLOWED QUERY : 500 CHARS

名誉ある言及： Copilotの手順*ファイルは、健康文書を補完するAI構成です。他のコミュニティヘルスファイルをコンテキストとして使用し、コードベースと対話する方法をGitHub Copilotに指示し、一貫性のある正確な支援を保証します。

##スターターキット： GitHub Copilotを使用してコミュニティヘルスファイルを更新する方法

3つの重要なファイルをリポジトリに追加するためのプロンプトのベストプラクティス、包括的なチェックリスト、ステップバイステップのチュートリアルを含むスターターキットをまとめました。

###パート1 ：促す

ゼロから始める場合でも、既存のドキュメントを絞り込む場合でも、GitHub Copilotは、わずか数回のプロンプトで、より明確で一貫性のあるコミュニティヘルスファイルを作成するのに役立ちます。

ヒント： Copilotに電力を供給するLLMは決定論的ではないため、同じプロンプトが毎回異なる出力を生成する可能性があります。迅速なエンジニアリングは品質を向上させますが、特に「ライセンス」などの法的ファイルの場合は、常に出力を検証します。

###パート2 ：チェックリスト

このチェックリストは、Copilotが生成したコンテンツが正確で、包括的で、安全で、プロジェクトの目標と一致していることを保証します。

🔍 始める前に

-類似または関連するリポジトリにある既存のコミュニティヘルスファイルを確認しましたか？
-各ファイルのメッセージに明確な目標（オンボーディング、期待、セキュリティレポート）がありますか？
-組織のGitHub使用ポリシーとブランディングガイドラインをご存知ですか？

🧠 ** Copilotを効果的に促す**

-プロンプトは具体的でコンテキストに基づいていますか？（例：「コードスタイルガイドを使用して、PythonベースのオープンソースプロジェクトのCONTRIBUTING.mdを生成する」）
-トーンの好みを含めましたか？（例：「インクルーシブな言葉遣いと歓迎の口調を使用する」）

🛡️ セキュリティとプライバシー

-機密情報や専有情報（認証情報、プライベートURL ）を含むプロンプトは避けてください。
-リポジトリの公開設定（公開または非公開）を確認し、ヘルスファイルがオーディエンスと一致していることを確認します。

Copilotのプライバシー設定がプロンプトや提案をどのように処理するかを把握します。
-「SECURITY.md」には次のものが含まれますか？
-脆弱性を報告するための明確な連絡方法
-セキュリティ上の問題がどのようにトリアージされるかについての簡単な説明
-責任ある開示ポリシーへのリンク

🧾 ** Copilot出力の確認**

-コンテンツは、プロジェクトの価値観とコミュニティの基準を反映していますか？
-幻覚のリンク、名前、またはポリシーが存在しませんか？
-すべての外部参照は正確で最新のものですか？

🧪 テストとフィードバック

-チームメイトまたは協力者に生成されたファイルを確認してもらっていますか？

README.mdまたは'CONTRIBUTING.md`でセットアップ手順をテストします。
-コミュニティからのフィードバックに基づいてイテレーションを受け入れるようにしてください。

###パート3 ：チュートリアル

以下は、3つの主要なコミュニティヘルスファイルにCopilotを使用するための迅速で実用的な手順です。

なぜでしょうか？明確な「README.md」は、ユーザーとコントリビューターがプロジェクトの目的と使用法をすばやく理解するのに役立ちます。

QUERY LENGTH LIMIT EXCEEDED. MAX ALLOWED QUERY : 500 CHARS

####ライセンス📄を追加する

なぜですか？「ライセンス」ファイルは、ユーザーの権利とユーザーの権利の両方を保護し、コードを使用、変更、配布する方法を明確にします。

IDEでGitHub Copilot Chatを開きます。
2.追加するライセンスを決定します。
3.プロンプト:
＞「私のプロジェクトにMITライセンスを追加してもらえますか？」
Copilotは「ライセンス」ファイルを生成します。
5.ライセンスの正確性（特に著作権所有者の名前）を確認します。
[保持]をクリックしてファイルを保存します。
7.ライセンスをコミットする