GitHub 上のプロジェクトの作業を最適化する: Github テンプレート リポジトリについて知る

JavaRush コミュニティの皆さん、こんにちは! 今日はオープンソースについて、そして書かれたコードに加えて 高品質のプロジェクトを作成するために何が必要かについて話します。役立つ製品を書くことが重要です。しかし、同様に重要なのは、リポジトリ (GitHub 上のプロジェクト リポジトリ) の正しい設計です。これは、もう 1 つの重要なポイントである製品プロモーションの実施に役立ちます。たとえそのプロジェクトが非常に素晴らしいものであっても、デザインが貧弱で、少なくとも README に記載されていない (README が何であるかについてはここで読むことができます)、ライセンスが表示されていない、などの場合は、失敗。ただ誰も彼に気づかないだけだ。そして誰かがそれに気付いたら、どう接していいのか分からなくなるでしょう。何度も何度も入力する必要がある項目がたくさんあり、プログラマーにとって毎回コピーして貼り付けるのは簡単ではありません。このため、この夏、GitHub はこれを支援するテンプレート リポジトリ機能をリリースしました。いわば、新しいプロジェクトを作成するプロセスを自動化します。今日は、リポジトリとは何か、テンプレート リポジトリとは何かを理解します。コード以外にプロジェクトに何を含めるべきか、何に重点を置く必要があるかを説明します。テンプレート リポジトリを最初から作成し、私の観点から必要なものをすべて追加してみましょう。最後に、新しいリポジトリを作成するときにテンプレート リポジトリを使用します。まず、用語を理解しましょう。 理論: プロジェクトの一般リポジトリに何を含めるべきかGitHub 上のすべてのオープンソース プロジェクトには、次の要素を含む 明確に説明されたコミュニティ プロファイルが必要です。

1. 発行テンプレート

ここでは、リポジトリ内に課題を作成するためのルール、つまり名前、ラベル、誰に割り当てるかを記述する必要があります。新しい問題を作成する場合、次のオプションが提供されます。

• バグレポート- プロジェクトの欠陥を説明する問題を作成します。
• 機能リクエスト- プロジェクトの新しいアイデアの提案。
• 改善リクエスト- プロジェクトの改善提案。
• カスタム課題テンプレート- 他のオプションが機能しない場合は、空のテンプレートを使用できます。

これがどのようなものであるかの例は、ここで見ることができます。

2. ライセンス

プロジェクトが作成されたライセンス。これは、プロジェクトを使用する人が何が保証され、何が保証されていないのかを知るために必要です。たとえば、Apache License 2.0には次のように記載されています。

3.README

これはプロジェクトの説明であり、その名刺です。プロジェクトについて言う必要があるすべてがここにあるはずです。もちろん、プロジェクトの詳細を考慮してその都度説明する必要がありますが、見出しは同じになります。例えば：

• 概要 - プロジェクトの簡単な説明。
• 使用法 - プロジェクトの使用方法。
• 構築 - プロジェクトを立ち上げる方法、これに必要なもの。
• トラブルシューティング - 発生する可能性のある問題とその解決方法について説明します。
• リリース ノート - バージョンに応じた変更点の説明。
• 著者 - 愛する人のことを忘れないでください。
• 貢献 - プロジェクトの開発にどのように参加できるかの説明。
• 行動規範 - 参加規則の説明。
• RELEASE_NOTES - 新しいバージョンのすべての変更が記録されるファイル。これを別のドキュメントに記載し、README にリンクを保存することをお勧めします。
• CONTRIBUTING は、このプロジェクトの開発にどのように貢献できるかを説明するファイルです。README の Contributing ヘッダー用に別のファイルとして作成されます。
• CODE_OF_CONDUCT - プロジェクトの開発に参加するためのルールを説明するファイル。
• プル リクエスト テンプレート- プル リクエストを作成する人のためのテンプレート。

これらすべては、プログラミング言語やその仕様に関係なく、プロジェクトからプロジェクトへと使用されます。

練習: 独自のテンプレートを作成する

よく言われるように、言葉から行動に移りましょう。ここで例を使用して、独自のテンプレートを作成する方法を説明します。

1. 最初に必要なのは GitHub のアカウントです /そこに登録します。

2. 新しいリポジトリを作成します。これを行うには、右上隅の + をクリックします。

3. 作成時に次のように入力します。

   • リポジトリ名 - 私の場合は repository-template です。
   • 説明 — プロジェクトの簡単な説明。
   • 「パブリック」のままにしますが、「プライベート」を選択することもできます。
   • README の初期化ボックスをチェックします。

   • プロジェクトに適用されるライセンスを選択します:

     私の場合、テンプレートは一般的なものであるため、gitignore は必要ありません。特定のプロジェクトとプログラミング言語用に追加されます。

     したがって、「リポジトリの作成」をクリックして、作成プロセスを完了します。システムにより、新しく作成されたリポジトリが自動的に表示されます。

4. コミュニティ プロファイルに記入します。作成したリポジトリで、[インサイト]タブに移動し、[コミュニティ]を選択します。

   ご覧のとおり、残っているのは、行動規範、貢献、問題テンプレート、プル リクエスト テンプレートに記入することだけです。

   行動規範の例を使用して、それらをプロジェクトに追加する方法を示します。

   「追加」をクリックすると、 「寄稿者規約」または「市民の行動規範」を選択するように求められます。

   最初のものを選択し、「確認して送信」をクリックします。

   次に、このファイルを編集してコミットできます。

   下部で、「マスター ブランチに直接コミット」オプションを選択し、「新しいファイルをコミット」をクリックします。

   その結果、コミュニティ プロフィールに戻ると、行動規範が追加済みとしてマークされていることがわかります。

   Contributing と Issue Template も同様の方法で追加されるため、ここでは示しません。自分でやれ ;）

5. プル リクエスト テンプレートを追加します。

   しかし、これについては別に話しましょう。

   なぜ GitHub がプルリクエスト テンプレートを設定するための同じ便利なオプションを追加していないのかわかりません。そのため、ドキュメントを調べて手動 で追加する必要があります。

   これを行うには、リポジトリのルートで[新しいファイルを作成]をクリックします。

   ファイル名は.github/pull_request_template.mdである必要があります。

   必要なものをテンプレートに追加し、上記と同様に[新しいファイルをコミット]をクリックします。車輪を再発明するつもりはありませんでしたが、私にとって非常に使えそうな例を見つけました。

   このようにして、コミュニティ プロフィール全体が入力されます。

6. テンプレート リポジトリマーカーを追加します。

   これを行うには、リポジトリの[設定]オプションに移動し、[テンプレート リポジトリ] と表示されているボックスをオンにします。

   これで、新しいプロジェクトを作成するためのテンプレートの準備が整いました。したがって、将来新しいプロジェクトを作成する必要があるときに、時間を大幅に節約できます。これは、ライセンスや問題の明確なテンプレートなど、何かを追加するのを忘れることがよくあるため、重要な詳細を見逃さないようにするのにも役立ちます。

テンプレートリポジトリの使用方法

使用には 2 つのオプションがあります。

1. テンプレートが自分によって直接所有されている場合:新しいリポジトリを作成するときに、所有しているテンプレートのリストにあるテンプレートから作成するオプションが表示されます。

2. テンプレートが外部の場合:ここでも特別な問題はありません。そのテンプレートに移動し、「このテンプレートを使用する」ボタンをクリックします。ここでは公式ドキュメントのアニメーションを使用します。

要約しましょう

この記事では次のことを検討しました。

• GitHub リポジトリとは何ですか。
• テンプレートリポジトリとは何ですか。
• テンプレート リポジトリに何を含めるべきか。
• テンプレート リポジトリの作成方法。
• テンプレート リポジトリの使用方法。

もちろん、このテンプレートに基づいて、より具体的なテンプレートをすでに作成できます。たとえば、すでに構成されているMavenまたはGradleビルド システムを使用してさらにテンプレートを作成しました。さらに、最後の 2 つに基づいて Spring Boot リポジトリ テンプレートを作成できます。すべてのテンプレートをグループ化するために、すべてのテンプレートを含む テンプレート リポジトリ組織を GitHub 上に作成しました。GitHub アカウントを購読する

役立つリンク

• 作成したすべてのテンプレートを使用した構成
• GitHub ブログ: リポジトリ テンプレートを使用して新しいリポジトリを生成する リポジトリのテンプレートを作成する方法
• GitHub ヘルプ: リポジトリについて リポジトリとは何かについて。
• GitHub ヘルプ: テンプレートからリポジトリを作成するテンプレートに基づいて新しいプロジェクトを作成する方法
• GitHub ヘルプ: リポジトリのライセンスプロジェクトのライセンスの説明
• GitHub ヘルプ:リポジトリの作成に関するリポジトリの説明を作成する
• オープンソース プロジェクトの作成/記述に関するオープンソース ガイドのヒント。
• GitHub ヘルプ: プル リクエスト テンプレートの追加- プル リクエスト用のテンプレートの作成。

私の記事をもっと見る

• Intellij IDEA でのデバッグ: 初心者向けガイド
• Skyscanner API のクライアントを作成し、jCenter および Maven Central で公開するためのガイド [パート 1]
• Skyscanner API のクライアントを作成し、jCenter および Maven Central で公開するためのガイド [パート 2]
• 航空券価格監視システムの作成: ステップバイステップガイド [パート 1]
• 航空券価格監視システムの作成: ステップバイステップガイド [パート 2]
• 航空券価格監視システムの作成: ステップバイステップガイド [パート 3]
• ロギング: 何を、どのように、どこで、何を使って行うのか?
• 面接テストがどのようにオープンソース ライブラリに変わったか
• 成功の歴史。週に 20 時間のプログラミング、修士号と私生活
• 仕事を見つけるにはどうすればいいですか？履歴書を送るときのヒント