[Django].gitignoreの内容

2021/05/04に公開

Djangoはデフォルトで.gitignoreがない

djangoってデフォルトで.gitignoreがないので自分で用意してやる必要があります。ということで今回はDjnaoの.gitignoreは何を用意すれば良いかという話をしようと思います。

.gitignoreに書く内容

だいたいこんなところかと思います。

.gitignore
*.log
*.pyc
__pycache__/
db-volumes/
db.sqlite3

ポイントは、

  • __pycache__/フォルダ(一応pycファイルも)
  • docker-composeで永続化しているdb-volumesフォルダ
  • DBを指定していない場合にデフォルトで生成されるdb.sqlite3
  • ログファイル

観点はこんな感じ

  • ログ(記録)のような情報
  • dbのボリュームなどの永続化情報
  • git管理したくない秘匿情報

こんなサービスも

こちらのサイトでは、検索バーに、「Python」や「Django」と打ち込むとそれに合わせた.gitignoreファイルを生成してくれるみたいです。記述量にやりすぎ感はありますが、とりあえず導入しておけば一安心って感じですね。

https://www.gitignore.io/

まとめ

コミットしてしまうと面倒なのでなるべく早めに.gitignoreを書いてしまいましょう!VScodeなどのエディタは無視しているファイルはファイル名がグレーになっていたりしてわかりやすいので是非活用してみてくださいね。

Discussion