前言
记录一下如何编写git忽略文件,文件的格式,以及使用pycharm插件帮助生成。
Git ignore文件
Git的忽略文件名为 .gitignore
,在这个文件中列出那些不希望添加到git中的文件名后,当使用git add .
时这些文件就会被自动忽略掉。
忽视文件的格式很简单,同时也支持格式匹配(包括文件和目录),用 *
表示省略,用#
表示注释,如:1
2
3
4
5
6
7
8
9
10
11
12
13# Java class Files
*.class
# Package Files
*.jar
*.war
*.ear
# 忽略名称中末尾为bin的目录
*bin/
# 忽略名称中间包含bin的目录
*bin*/
GitHub也给出了各种各样项目的忽视文件模版,见这里。
忽视文件的一般原则
忽略操作系统自动生成的文件,比如缩略图等。
忽略编译生成的中间文件、可执行文件等,也就是如果一个文件是通过另一个文件自动生成的,那自动生成的文件就没必要放进版本库,比如Java编译产生的.class文件。
忽略自己带有敏感信息的配置文件,比如存放口令的配置文件。
Pycharm添加git忽视文件
下载.ignore插件:
然后在项目根目录上右键移到New,就可以看到.ignore的选项。从中选择gitignore文件,还可以选择一些模版创建,也可以直接建立空的忽视文件。