A collection of useful .gitignore templates
Go to file
Carl Suster 8bc0e535bb Merge Pull Request #1338 for Eclipse
Fixes #1217.

Once again ignore .classpath and .project in the Eclipse template. This has
been requested in multiple PRs such as #1338 and #1221 and is essentially a
reversion of #805. I copy the explanation for this change from the discussion
in #1217 by @segfly:

*In short*:

I can't point to any counter-documentation off the top of my head. I just know
from experience these files pollute a project's repo without adding value
- that is, unless everyone contributing is using Eclipse and no-one is using
dependency management. And even then, the guidance provided by the eclipse docs
is bad advice.

*In Long*:

The .classpath file is used by Eclipse to maintain the project's classpath
during automatic compile (every save of a file). In the olden days, one would
manually configure the project within the Eclipse UI and include all the
dependent jars necessary to compile your project. Eclipse then wrote that
configuration out to the .classpath file.

In theory, this file could be shared with others so they did not have to
manually configure their eclipse classpath. In practice, I never saw it work
out quite so well due to eventual bloating of the classpath with needless jars
or jars that only existed on one person's machine. Mind you, many people back
then also used to check their dependent jars into version control along with
their source.

Dependency management tools like Gradle and Maven have done away with all that
of course. But they also integrate nicely with Eclipse and manage the project
classpath dynamically. The .classpath file is basically rebuilt based on
changes to the build.gradle file or pom.xml file. Effectively, this renders the
whole point of checking in the .classpath moot as it is easily rebuilt by the
Maven or Gradle plugin.

The .project file is another animal completely. It basically describes what
plugins should be applied to the project as configured in the Eclipse UI. Again
the theory is it could be shared and creates a happy world. But due to
different eclipse versions people may have, different plugins installed, etc.
sharing the .project file actually causes more issues. And I've seen many
projects unable to open due to a bad .project file - requiring one to delete it
anyway (which then of course, when someone recreates it, they inevitably check
it in over the old one and end up breaking someone else's environment).

The bottom line is, regardless of what the eclipse documentation says, these
are very much internal configuration files for eclipse and best left out of
a repo.
2015-01-15 11:41:35 +11:00
Global Merge Pull Request #1338 for Eclipse 2015-01-15 11:41:35 +11:00
Actionscript.gitignore ensure single trailing newline 2013-10-06 14:40:01 +02:00
Ada.gitignore ensure single trailing newline 2014-03-27 17:04:56 +01:00
Agda.gitignore Create Agda.gitignore 2013-08-15 03:18:55 +02:00
Android.gitignore moved 2015-01-07 19:40:23 +05:30
AppceleratorTitanium.gitignore Added Appcelerator Titanium .gitignore file. 2012-08-22 18:06:15 -07:00
ArchLinuxPackages.gitignore Add .SRCINFO 2014-11-23 16:59:38 +01:00
Autotools.gitignore Add stamp-h1 to ignored files 2013-02-25 20:36:52 +01:00
C.gitignore added: rules for ingnoring precompiled headers for C/C++ 2014-08-27 13:36:18 +08:00
C++.gitignore added: rules for ingnoring precompiled headers for C/C++ 2014-08-27 13:36:18 +08:00
CakePHP.gitignore rearrange rules for CakePHP 2 2015-01-04 15:44:47 +01:00
CFWheels.gitignore add cfwheels gitignore 2011-02-21 18:02:55 -08:00
ChefCookbook.gitignore Remove lockfiles from Chef template 2014-03-07 00:24:00 +11:00
Clojure.gitignore Add .gitignore for Leiningen projects 2011-04-08 21:02:05 +03:00
CMake.gitignore Added a .gitignore for files auto-generated by the CMake build-system. 2010-11-09 15:51:41 +08:00
CodeIgniter.gitignore Fix eol issues 2014-04-23 16:02:01 -05:00
CommonLisp.gitignore Added file for Common Lisp. 2013-11-27 07:31:41 +01:00
Composer.gitignore Fix eol issues 2014-04-23 16:02:01 -05:00
Concrete5.gitignore ensure single trailing newline 2013-10-06 14:40:01 +02:00
CONTRIBUTING.md extract out new contributing guidelines to CONTRIBUTING.md 2013-11-05 17:05:25 +00:00
Coq.gitignore ensure single trailing newline 2013-10-06 14:40:01 +02:00
CraftCMS.gitignore Removing .DS_Store rule as it is included in global rules 2014-06-24 10:01:43 -04:00
Dart.gitignore Update Dart.gitignore 2014-09-17 21:31:39 -07:00
Delphi.gitignore Added Castalia *.stat files 2014-12-01 23:08:13 +03:00
DM.gitignore ensure single trailing newline 2014-03-27 17:04:56 +01:00
Drupal.gitignore Fixes uncomplete CTools 2014-03-24 17:14:52 +01:00
Eagle.gitignore .gitignore file for Eagle 2012-08-15 01:43:20 +02:00
Elisp.gitignore elisp: adding .cask files to gitignore 2014-05-30 22:11:45 +05:30
Elixir.gitignore Add .gitignore for Elixir 2014-05-04 18:27:23 +02:00
EPiServer.gitignore ensure single trailing newline 2014-03-27 17:04:56 +01:00
Erlang.gitignore Add ebin, rel example, concrete dev mode, .rebar 2014-08-22 01:15:23 -07:00
ExpressionEngine.gitignore Merge pull request #488 from nanadevelopment/eeConfigAdd 2013-11-11 05:37:55 -08:00
ExtJs.gitignore Should "boostrap.json" be "bootstrap.json"? 2015-01-06 17:11:00 -07:00
Fancy.gitignore ensure single trailing newline 2014-03-27 17:04:56 +01:00
Finale.gitignore ensure single trailing newline 2013-10-06 14:40:01 +02:00
ForceDotCom.gitignore ensure single trailing newline 2013-10-06 14:40:01 +02:00
Fortran.gitignore Link a new fortran template to existing c++ one 2014-07-16 23:09:37 +10:00
FuelPHP.gitignore FuelPHP gitignore 2011-08-17 00:55:26 -05:00
Gcov.gitignore Capitalise initial letter in template filenames for consistency/sorting 2015-01-07 15:16:27 +11:00
GitBook.gitignore Keep only important node rules in GitBook.gitignore 2014-09-03 13:19:51 +02:00
Go.gitignore Ignore profile files 2014-06-06 16:53:21 +03:00
Gradle.gitignore Avoid ignoring Gradle wrapper jar file 2014-11-18 17:30:56 +01:00
Grails.gitignore Adding additional comments 2014-09-08 00:52:39 -04:00
GWT.gitignore Adding ".gwt/", "gwt-unitCache/", "www-test" and ".gwt-tmp/" to .gitignore 2013-11-13 03:00:19 +01:00
Haskell.gitignore Merge pull request #1271 from bitemyapp/patch-1 2014-11-12 18:41:20 +11:00
Idris.gitignore Add an Idris gitignore 2014-02-27 21:51:51 -05:00
IGORPro.gitignore Create IGORPro.gitignore 2014-12-03 11:33:11 +01:00
Java.gitignore gitignore VM crash logs 2014-01-18 10:29:50 +01:00
Jboss.gitignore Deployed file ignore 2013-07-25 06:18:55 -07:00
Jekyll.gitignore Update Jekyll.gitignore 2014-09-06 16:10:32 +02:00
Joomla.gitignore Use absolute paths to the files to ignore 2013-11-26 20:37:48 -08:00
Jython.gitignore Jython ignores 2010-11-09 04:49:58 +08:00
Kohana.gitignore ensure single trailing newline 2013-10-06 14:40:01 +02:00
LabVIEW.gitignore LabVIEW.gitignore 2014-06-24 10:56:38 -05:00
Laravel.gitignore Renaming Laravel4 to Laravel 2014-09-02 15:51:10 +10:00
Leiningen.gitignore Added Cider's .nrepl-port file. 2014-10-15 12:23:58 -04:00
LemonStand.gitignore ensure single trailing newline 2013-10-06 14:40:01 +02:00
LICENSE Updated the year :-) 2014-02-13 15:57:44 +02:00
Lilypond.gitignore Add ignore file for lilypond. 2011-02-21 17:57:27 -08:00
Lithium.gitignore The Lithium app should be the root repo folder 2012-09-01 19:10:36 -03:00
Lua.gitignore Added a .gitignore template for Lua based projects. 2015-01-03 17:12:56 +00:00
Magento.gitignore Merge pull request #1311 from rafaelstz/patch-1 2015-01-08 12:55:10 +11:00
Maven.gitignore Add 'pom.xml.versionsBackup' 2014-03-31 02:52:46 +02:00
Mercury.gitignore Mercury.gitignore: Add Erlang .beams, as this is an 2014-05-12 10:00:08 +02:00
MetaProgrammingSystem.gitignore Grammar/formatting tweak to comments 2014-06-12 11:42:57 +10:00
Meteor.gitignore ensure single trailing newline 2014-03-27 17:04:56 +01:00
Nanoc.gitignore Capitalise initial letter in template filenames for consistency/sorting 2015-01-07 15:16:27 +11:00
Nim.gitignore Create Nim.gitignore 2014-12-30 17:23:11 -05:00
Node.gitignore Ignore npm-debug.log 2015-01-02 01:38:25 +01:00
Objective-C.gitignore [Objective-C] Fixes a broken link 2014-04-24 15:01:04 +01:00
OCaml.gitignore Add ocamlbuild and oasis generated files to OCaml .gitignore 2014-09-24 18:08:03 +07:00
Opa.gitignore Added Opa.gitignore 2012-03-03 02:08:17 +01:00
OpenCart.gitignore Returned lost config file 2014-04-08 18:48:50 +03:00
OracleForms.gitignore added gitignore for Oracle Forms development 2012-03-19 16:46:57 -04:00
Packer.gitignore Add a support for packer 2014-03-09 14:35:00 +09:00
Perl.gitignore ignore more perl outputs 2013-01-07 21:25:52 -08:00
Phalcon.gitignore Remove trailing asterisks in Phalcon rules 2014-03-21 12:57:41 +11:00
PlayFramework.gitignore Increase the specificity of PlayFramework rules 2014-03-21 12:46:27 +11:00
Plone.gitignore Covered by global vim template 2013-11-12 15:09:20 +07:00
Prestashop.gitignore ensure single trailing newline 2014-03-27 17:04:56 +01:00
Processing.gitignore Added the processing project 2013-09-26 16:19:15 -04:00
Python.gitignore Merge pull request #955 from arjun024/master 2014-09-01 22:27:51 +10:00
Qooxdoo.gitignore Add gitignore for qooxdoo apps 2011-02-21 18:08:18 -08:00
Qt.gitignore Ignore Qt Creator cache files for Qbs projects. 2014-11-16 12:04:57 -08:00
R.gitignore Merge pull request #1263 from jangorecki/master 2014-11-29 15:38:28 +11:00
Rails.gitignore Merge pull request #1257 from sidewinder94/patch-1 2015-01-07 16:58:02 +11:00
README.md add a section about not including every template under the sun 2013-11-05 00:26:19 +00:00
RhodesRhomobile.gitignore Add Rhodes mobile application framework gitignore 2010-11-10 03:44:16 +08:00
ROS.gitignore Remove unnecessary rules 2014-04-23 20:46:03 +09:00
Ruby.gitignore Merge RubyMotion into Ruby 2014-03-07 00:15:40 +11:00
Rust.gitignore revert 2014-11-06 09:27:27 +02:00
Sass.gitignore Add sourcemaps to the Sass ignore 2014-09-17 11:23:16 -07:00
Scala.gitignore Ignore .history files 2014-10-19 08:59:24 -02:00
SCons.gitignore Added SCons.gitignore 2013-12-17 15:06:57 +08:00
Scrivener.gitignore Added .gitignore for Scrivener 2013-11-11 14:34:42 +00:00
Sdcc.gitignore ensure single trailing newline 2013-10-06 14:40:01 +02:00
SeamGen.gitignore Update SeamGen.gitignore 2012-07-31 11:57:21 +08:00
SketchUp.gitignore Add gitignore for sketchup backup files. 2012-01-18 17:33:11 -06:00
Stella.gitignore Capitalise initial letter in template filenames for consistency/sorting 2015-01-07 15:16:27 +11:00
SugarCRM.gitignore Explanations for ignoring the cache directory 2013-11-27 17:30:57 +01:00
Swift.gitignore Add Swift.gitignore 2014-07-23 19:23:20 -03:00
Symfony.gitignore Add 'build' directory 2014-09-02 11:12:15 +02:00
SymphonyCMS.gitignore added symphony and workspace/uploads dir 2012-04-11 11:39:01 +03:00
TeX.gitignore Update TeX.gitignore 2015-01-13 09:40:43 +01:00
Textpattern.gitignore Added Textpattern gitignore 2012-01-17 11:04:16 +00:00
TurboGears2.gitignore Add for TurboGears2 (based off of Python template) 2010-11-09 15:46:02 +08:00
Typo3.gitignore Update Typo3.gitignore - added version number as TYPO3 CMS v6 needs different .gitignore file 2013-01-09 13:37:51 +01:00
Umbraco.gitignore Update Umbraco.gitignore 2014-09-29 16:31:58 +02:00
Unity.gitignore Add space at Unity gitignore comment 2014-12-12 10:25:22 +08:00
VisualStudio.gitignore Merge pull request #1349 from MOROZILnic/patch-1 2015-01-08 12:48:38 +11:00
VVVV.gitignore ensure single trailing newline 2014-03-27 17:04:56 +01:00
Waf.gitignore added Waf.gitignore 2010-11-22 17:54:05 -08:00
WordPress.gitignore sort WordPress.gitignore 2014-06-19 15:01:02 -07:00
Xojo.gitignore Ignores *.xojo_uistate 2014-09-14 11:54:56 -04:00
Yeoman.gitignore Create Yeoman.gitignore 2013-10-21 16:20:37 +11:00
Yii.gitignore Merge remote-tracking branch 'origin/master' into pr/506 2013-11-11 09:51:38 -08:00
ZendFramework.gitignore Fixed binary gettext files rule: .po -> .mo 2014-08-21 13:26:02 +01:00
Zephir.gitignore Added comments for Zephir 2014-06-21 20:02:16 +04:00

A collection of .gitignore templates

This is GitHubs collection of .gitignore file templates. We use this list to populate the .gitignore template choosers available in the GitHub.com interface when creating new repositories and files.

For more information about how .gitignore files work, and how to use them, the following resources are a great place to start:

Folder structure

The files in the root directory are for .gitignore templates that are project specific, such as language or framework specific templates. Global (operating system or editor specific) templates should go into the Global/ directory.

Contributing guidelines

Wed love you to help us improve this project. To help us keep this collection high quality, we request that contributions adhere to the following guidelines.

  • Provide a link to the application or projects homepage. Unless its extremely popular, theres a chance the maintainers dont know about or use the language, framework, editor, app, or project your change applies to.

  • Provide links to documentation supporting the change youre making. Current, canonical documentation mentioning the files being ignored is best. If documentation isnt available to support your change, do the best you can to explain what the files being ignored are for.

  • Explain why youre making a change. Even if it seems self-evident, please take a sentence or two to tell us why your change or addition should happen. Its especially helpful to articulate why this change applies to everyone who works with the applicable technology, rather than just you or your team.

  • Please consider the scope of your change. If your change specific to a certain language or framework, then make sure the change is made to the template for that language or framework, rather than to the template for an editor, tool, or operating system.

  • Please only modify one template per pull request. This helps keep pull requests and feedback focused on a specific project or technology.

In general, the more you can do to help us understand the change youre making, the more likely well be to accept your contribution quickly.

Please also understand that we cant list every tool that ever existed. Our aim is to curate a collection of the most common and helpful templates, not to make sure we cover every project possible. If we choose not to include your language, tool, or project, its not because its not awesome.

Contributing workflow

Heres how we suggest you go about proposing a change to this project:

  1. Fork this project to your account.
  2. Create a branch for the change you intend to make.
  3. Make your changes to your fork.
  4. Send a pull request from your forks branch to our master branch.

Using the web-based interface to make changes is fine too, and will help you by automatically forking the project and prompting to send a pull request too.

License

MIT.