LoginSignup
17
19

More than 5 years have passed since last update.

gitとgithubの設定ファイルまとめ

Posted at

この記事について

gitの設定ファイルにはどんなものがあるか気になってので調べてみました。
ただのまとめで項目ごとの詳しい解説ではありません。

git

.gitignore

一番よく使うであろう.gitignore
名前の通り、gitの管理下から外す対象を指定できます。
以下のサイトによくまとまっています。
* [Git] .gitignoreの仕様詳解 - Qiita

.gitignoreの設定にはにはgiboが便利です。
* Git - gitignore Documentation
* simonwhitaker/gibo: A shell script for easily accessing gitignore boilerplates

.gitkeep

空ディレクトリを管理するためのファイル。
.gitkeep(または、.keep)という名前は絶対ではないようですが慣例でそうなっているようです。

.gitmodules

git submoduleによって作成されるファイル。
git submoduleは外部のレポジトリを自レポジトリに導入し管理するときに使います。

.gitattributes

指定したファイルをどのように扱うかを設定します。

「属性を使うと、ファイルやディレクトリ単位で個別のマージ戦略を指定したり、テキストファイル以外の diff を取る方法を指示したり、あるいはチェックインやチェックアウトの前にその内容を Git にフィルタリングさせたりできます。」
Git - gitattributes Documentation

.gitconfig

gitの設定ファイル。
エディタやエイリアスなどの設定もできます。

.gitmessage

コミットメッセージのテンプレートを設定することができます。

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

参考

17
19
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
17
19