CODEWITHSUNDEEP
gitgitignore
Howard
Howard

Reputation: 19805

Should you commit .gitignore into the Git repos?

Do you think it is a good practice to commit .gitignore into a Git repo?

Some people don't like it, but I think it is good as you can track the file's history. Isn't it?

Upvotes: 650

Views: 259605

Answers (6)

Bruce Stephens
Bruce Stephens

Reputation: 7443

Normally yes, .gitignore is useful for everyone who wants to work with the repository. On occasion, you'll want to ignore more private things (maybe you often create LOG or something). In those cases you probably don't want to force that on anyone else.

Upvotes: 627

Uday
Uday

Reputation: 199

For me I think it is a good idea to commit .gitignore file to the repository. When someone clones your repository and build project, or run some tests that does generate some junk data may not needed to push it.. .gitignore file just ignore files that are configured in it..

Upvotes: 1

Patrick Perdu
Patrick Perdu

Reputation: 21

Committing .gitignore can be very useful but you want to make sure you don't modify it too much thereafter especially if you regularly switch between branches. If you do you might get cases where files are ignored in a branch and not in the other, forcing you to go manually delete or rename files in your work directory because a checkout failed as it would overwrite a non-tracked file.

Therefore yes, do commit your .gitignore, but not before you are reasonably sure it won't change that much thereafter.

Upvotes: 2

Stéphan Kochen
Stéphan Kochen

Reputation: 19943

You typically do commit .gitignore. In fact, I personally go as far as making sure my index is always clean when I'm not working on something. (git status should show nothing.)

There are cases where you want to ignore stuff that really isn't project specific. For example, your text editor may create automatic *~ backup files, or another example would be the .DS_Store files created by OS X.

I'd say, if others are complaining about those rules cluttering up your .gitignore, leave them out and instead put them in a global excludes file.

By default this file resides in $XDG_CONFIG_HOME/git/ignore (defaults to ~/.config/git/ignore), but this location can be changed by setting the core.excludesfile option. For example:

git config --global core.excludesfile ~/.gitignore

Simply create and edit the global excludesfile to your heart's content; it'll apply to every git repository you work on on that machine.

Upvotes: 174

Bitdiot
Bitdiot

Reputation: 1598

I put commit .gitignore, which is a courtesy to other who may build my project that the following files are derived and should be ignored.

I usually do a hybrid. I like to make makefile generate the .gitignore file since the makefile will know all the files associated with the project -derived or otherwise. Then have a top level project .gitignore that you check in, which would ignore the generated .gitignore files created by the makefile for the various sub directories.

So in my project, I might have a bin sub directory with all the built executables. Then, I'll have my makefile generate a .gitignore for that bin directory. And in the top directory .gitignore that lists bin/.gitignore. The top one is the one I check in.

Upvotes: 14

Jakub Narębski
Jakub Narębski

Reputation: 323464

It is a good practice to .gitignore at least your build products (programs, *.o, etc.).

Upvotes: -10

Related Questions