Skip to main content

このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2023-01-18. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise にアップグレードします。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください

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

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

README ファイルを作成する

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

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

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

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

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

Git Large File Storage を使う

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

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