この記事について
gitの設定ファイルにはどんなものがあるか気になってので調べてみました。
ただのまとめで項目ごとの詳しい解説ではありません。
git
.gitignore
一番よく使うであろう.gitignore
。
名前の通り、gitの管理下から外す対象を指定できます。
以下のサイトによくまとまっています。
.gitignore
の設定にはにはgiboが便利です。
- Git - gitignore Documentation
- simonwhitaker/gibo: A shell script for easily accessing gitignore boilerplates
.gitkeep
空ディレクトリを管理するためのファイル。
.gitkeep
(または、.keep
)という名前は絶対ではないようですが慣例でそうなっているようです。
.gitmodules
git submoduleによって作成されるファイル。
git submoduleは外部のレポジトリを自レポジトリに導入し管理するときに使います。
- Git submodule の基礎 - Qiita
- Git submoduleの抑えておきたい理解ポイントのまとめ - Qiita
- 自分が必要とする最低限の git submodule の知識 - Qiita
.gitattributes
指定したファイルをどのように扱うかを設定します。
「属性を使うと、ファイルやディレクトリ単位で個別のマージ戦略を指定したり、テキストファイル以外の diff を取る方法を指示したり、あるいはチェックインやチェックアウトの前にその内容を Git にフィルタリングさせたりできます。」
Git - gitattributes Documentation
.gitconfig
gitの設定ファイル。
エディタやエイリアスなどの設定もできます。
.gitmessage
コミットメッセージのテンプレートを設定することができます。
- Better Commit Messages with a .gitmessage Template
- Git - Git Configuration
- Git のコミットメッセージをテンプレート化する - Qiita
github
.github/
以下のファイルを.github
内か、ルート直下に置くと
issue作成時、pull request作成時などのテンプレートを用意することができます。
拡張子はなしでも、.md
でも.txt
でも良いです。
- CONTRIBUTING
- ISSUE_TEMPLATE
- PULL_REQUEST_TEMPLATE
- CODE_OF_CONDUCT.md
- LICENSE or LICENSE.txt
Issue and Pull Request templates