Skip to main content

リポジトリのベスト プラクティス

リポジトリを最も効果的に使用する方法について説明します。

README ファイルを作成する

作業内容を理解して参照しやすくするために、リポジトリごとに README ファイルを作成することをお勧めします。

README ファイルをリポジトリに追加して、プロジェクトに関する重要な情報を伝えることができます。 README は、リポジトリ ライセンス、引用ファイル、コントリビューション ガイドライン、倫理規定と並んで、プロジェクトに期待されるものを伝え、コントリビューションを管理しやすくします。 詳細については、「READMEについて」を参照してください。

フォークよりもブランチを優先する

コラボレーションを合理化するために、通常のコラボレーターは 1 つのリポジトリから作業し、リポジトリ間ではなくブランチ間で pull request を作成することをお勧めします。 フォークは、プロジェクトに関係のない人 (オープンソースの共同作成者など) からのコントリビューションを受けるのに最適です。

ブランチ ワークフローを使用しながら、重要なブランチ (main など) の品質を維持するために、必要な状態チェックと pull request レビューで保護されたブランチを使用できます。 詳しくは、「保護されたブランチについて」を参照してください。

Git Large File Storage を使う

パフォーマンスを最適化するために、GitHub ではリポジトリ内で許可されるファイルのサイズが制限されています。 詳しくは、「GitHub での大きいファイルについて」を参照してください。

Git リポジトリで大きなファイルを追跡するには、Git Large File Storage (Git LFS) を使うことをお勧めします。 詳しくは、「Git Large File Storageについて」を参照してください。