Gitリポジトリがあります。プロジェクトをローカルで機能させるために必要なインストール手順を追加したいと思います。このプロジェクトは会社および民間のプロジェクトであり、ユーザーも貢献者になります。私はGitLabを使用しています。
しかし、私はこれらのステップをどのファイルで書くべきか分かりません。私は次のようないくつかのオプションを心に留めています:
README.md
ファイル:これは、ユーザーと寄稿者に表示されるデフォルトのページです。しかし、1つのファイル内の情報が多すぎると、読みにくくなるのではないかと心配しています。CONTRIBUTING.md
ファイル:私の場合、プロジェクトをインストールする人が貢献者になります。貢献したい場合は、プロジェクトをローカルにインストールする必要があります。INSTALL.md
ファイル:GitLabはCONTRIBUTING
およびREADME
として認識されません。しかし、名前にはインストール手順が含まれていることがはるかに明らかです。この場合のベストプラクティスは何ですか?
INSTALL.md
プロジェクト内。 「これをインストールするにはどうすればいいですか?」その場合、INSTALL.mdは明白な場所です。
README.mdに、インストールに関する小さなセクションを追加し、基本的にGitLabでホストされているINSTALL.mdファイルを紹介します。
プロジェクトについて
...
貢献する
..
インストール手順
詳細な手順については、 INSTALL.md を参照してください。
これにより、両方の長所が得られます。適切な名前のファイルと、GitLabでレンダリングされたREADMEファイルから適切な名前のファイルへのリンクを取得します。
実際、これは、GitHub、Azure DevOps、またはREADMEファイルで特別なことを行う他のgitホスティングソリューション)で機能します。