You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Brian Douglas cdd9e946da
Merge pull request #3757 from parsalotfy/patch-3
1 week ago
.github Trim trailing whitespace 3 years ago
Global Merge pull request #3326 from dsrini-open/aws-changes 6 months ago
community Merge pull request #3781 from GrpeApple/master 2 months ago
.travis.yml .travis.yml: Trim trailing whitespace and indent (#3118) 2 years ago
Actionscript.gitignore Fix comments on same line causing ignore to break 4 years ago
Ada.gitignore ensure single trailing newline 8 years ago
Agda.gitignore Add MAlonzo directory. (#2978) 3 years ago
Android.gitignore Add `.idea/jarRepositories.xml` to Android.gitignore 5 months ago
AppEngine.gitignore Added template for Google App Engine 7 years ago
AppceleratorTitanium.gitignore Added Appcelerator Titanium .gitignore file. 9 years ago
ArchLinuxPackages.gitignore Add .jar, .exe and .msi 6 years ago
Autotools.gitignore Merge pull request #3652 from arthur-targaryen/patch-1 4 months ago
C++.gitignore added prerequisites for C and C++ 5 years ago
C.gitignore Update C.gitignore 5 years ago
CFWheels.gitignore add cfwheels gitignore 11 years ago
CMake.gitignore Ignore CMake FetchContent directory 3 years ago Trim trailing whitespace 3 years ago
CUDA.gitignore Add CUDA.gitignore 7 years ago
CakePHP.gitignore Update CakePHP.gitignore 6 years ago
ChefCookbook.gitignore Remove lockfiles from Chef template 8 years ago
Clojure.gitignore Add .gitignore for Leiningen projects 11 years ago
CodeIgniter.gitignore Merge branch 'master' into codeigniter3update 5 years ago
CommonLisp.gitignore Update CommonLisp.gitignore 5 years ago
Composer.gitignore Fix link to go to current anchor 4 years ago
Concrete5.gitignore Update concrete5 gitignore (#3176) 2 years ago
Coq.gitignore Update Coq.gitignore 6 months ago
CraftCMS.gitignore Craft: update to follow official recs; add 'not necessary in v3' note 3 years ago
D.gitignore Update D.gitignore 5 years ago
DM.gitignore ensure single trailing newline 8 years ago
Dart.gitignore Update Dart.gitignore 6 months ago
Delphi.gitignore Update Delphi.gitignore 3 years ago
Drupal.gitignore Update Drupal.gitignore (#3329) 2 years ago
EPiServer.gitignore ensure single trailing newline 8 years ago
Eagle.gitignore Eagle: Remove duplicate entry 3 years ago
Elisp.gitignore add final newline 5 years ago
Elixir.gitignore ignore files generated by ElixirLS 3 years ago
Elm.gitignore Ignore elm-stuff project-wide 5 years ago
Erlang.gitignore Add rebar3 tool files and directories (#3178) 2 years ago
ExpressionEngine.gitignore Merge pull request #488 from nanadevelopment/eeConfigAdd 8 years ago
ExtJs.gitignore Adds some files 4 years ago
Fancy.gitignore ensure single trailing newline 8 years ago
Finale.gitignore ensure single trailing newline 8 years ago
ForceDotCom.gitignore ensure single trailing newline 8 years ago
Fortran.gitignore Link a new fortran template to existing c++ one 7 years ago
FuelPHP.gitignore update FuelPHP.gitignore 7 years ago
GWT.gitignore GWT: Remove duplicate entry 3 years ago
Gcov.gitignore Capitalise initial letter in template filenames for consistency/sorting 7 years ago
GitBook.gitignore Correct URL for NPM URL reference 7 years ago
Go.gitignore ignore vendor directory (#3033) 3 years ago
Godot.gitignore Remove pointless blank line from the beginning of the Godot file (#3466) 1 year ago
Gradle.gitignore Delete fixed workaround 8 months ago
Grails.gitignore Adding additional comments 7 years ago
Haskell.gitignore Add *.hie to Haskell.gitignore (#3120) 2 years ago
IGORPro.gitignore Create IGORPro.gitignore 7 years ago
Idris.gitignore Add an Idris gitignore 8 years ago
JBoss.gitignore correct capitalization problems and add Octave which link to MATLAB 3 years ago
JENKINS_HOME.gitignore Improved JENKINS_HOME example (#3332) 2 years ago
Java.gitignore Added NiFi .nar files 4 years ago
Jekyll.gitignore Update Jekyll.gitignore (#2540) 4 years ago
Joomla.gitignore Updating Joomla.gitignore to Joomla! 3.9.8 (#3090) 2 years ago
Julia.gitignore Add more standard ignored files for Julia (#2992) 3 years ago
KiCad.gitignore KiCad: add *.kicad_sch-bak and *.kicad_prl (#3427) 1 year ago
Kohana.gitignore ensure single trailing newline 8 years ago
Kotlin.gitignore Symlink Kotlin.gitignore to Java.gitignore 6 years ago
LICENSE Use the exact CC-0 license text 5 years ago
LabVIEW.gitignore Ignore the .cache folder for LabVIEW projects 4 years ago
Laravel.gitignore Update Laravel.gitignore (#3098) 2 years ago
Leiningen.gitignore Update .gitignore with .cpcache 4 years ago
LemonStand.gitignore ensure single trailing newline 8 years ago
Lilypond.gitignore Add ignore file for lilypond. 11 years ago
Lithium.gitignore The Lithium app should be the root repo folder 9 years ago
Lua.gitignore Added a .gitignore template for Lua based projects. 7 years ago
Magento.gitignore Remove patch files from repo 3 years ago
Maven.gitignore Reference why to exclude binary jar, fixes #111 (#3154) 2 years ago
Mercury.gitignore Mercury.gitignore: Add Mercury.modules 7 years ago
MetaProgrammingSystem.gitignore Grammar/formatting tweak to comments 7 years ago
Nanoc.gitignore Nanoc: Ignore tmp/nanoc/, not tmp/ 4 years ago
Nim.gitignore Updated Nim.gitignore (#3172) 2 years ago
Node.gitignore Merge pull request #3651 from kachick/node-ignore-envs 5 months ago
OCaml.gitignore Update OCaml.gitignore (#3010) 3 years ago
Objective-C.gitignore Improving the documentation of Objective-C and Swift files (#3133) 2 years ago
Opa.gitignore Added Opa.gitignore 10 years ago
OpenCart.gitignore excluding vqmod cache files and logs 5 years ago
OracleForms.gitignore added gitignore for Oracle Forms development 10 years ago
Packer.gitignore Add crash.log to Packer.gitignore (#3230) 2 years ago
Perl.gitignore spelling: utils 4 years ago
Phalcon.gitignore Remove trailing asterisks in Phalcon rules 8 years ago
PlayFramework.gitignore Added /project/project to PlayFramework.gitignore 5 years ago
Plone.gitignore Covered by global vim template 8 years ago
Prestashop.gitignore Update for Prestashop 1.7 (#3261) 2 years ago
Processing.gitignore Ignore transpiled .java and .class files (#3016) 3 years ago
PureScript.gitignore Update PureScript adding .spago (#3278) 2 years ago
Python.gitignore Remove pip-wheel-metadata/ from Python.gitignore (#3364) 2 years ago
Qooxdoo.gitignore Add gitignore for qooxdoo apps 11 years ago
Qt.gitignore Remove trailing whitespace 3 months ago
R.gitignore ignore *~ files in the po directory (#3453) 1 year ago Add period and capitalized letter for formatting 4 months ago
ROS.gitignore Added ignore for files created by `catkin_make_isolated` 4 years ago
Rails.gitignore Add /public/uploads for file upload gem Shrine (#3333) 2 years ago
Raku.gitignore Changes the name of Perl 6 to Raku (#3312) 2 years ago
RhodesRhomobile.gitignore Add Rhodes mobile application framework gitignore 11 years ago
Ruby.gitignore Ruby: ignore RuboCop remote inherited config files (#3197) 2 years ago
Rust.gitignore Rust: ignore .pdb files 6 months ago
SCons.gitignore Update SCons.gitignore (#3001) 3 years ago
Sass.gitignore Add all sourcemap file formats 3 years ago
Scala.gitignore add scala jvm crash files 6 months ago
Scheme.gitignore Add Scheme.gitignore 6 years ago
Scrivener.gitignore Added new checksums and allows for relative directories (#3128) 2 years ago
Sdcc.gitignore ensure single trailing newline 8 years ago
SeamGen.gitignore Update SeamGen.gitignore 9 years ago
SketchUp.gitignore Add gitignore for sketchup backup files. 10 years ago
Smalltalk.gitignore Merge pull request #2027 from rejurime/dolphin-smalltalk 3 years ago
Stella.gitignore Capitalise initial letter in template filenames for consistency/sorting 7 years ago
SugarCRM.gitignore ensure the following ! rules are included 5 years ago
Swift.gitignore Improving the documentation of Objective-C and Swift files (#3133) 2 years ago
Symfony.gitignore Ignore logs for Symfony4 3 years ago
SymphonyCMS.gitignore added symphony and workspace/uploads dir 10 years ago
TeX.gitignore Merge pull request #3669 from koppor/patch-2 6 months ago
Terraform.gitignore Remove trailing whitespace 3 months ago
Textpattern.gitignore Added Textpattern gitignore 10 years ago
TurboGears2.gitignore Add for TurboGears2 (based off of Python template) 11 years ago
TwinCAT3.gitignore After adding the new product "TF3680 - TC3 Filter" as a reference, some new files were automatically generated after compilation: 1 year ago
Typo3.gitignore Merge pull request #1646 from josefglatz/TYPO3-improvements 3 years ago
Umbraco.gitignore Remove trailing whitespace 3 months ago
Unity.gitignore Add *.aab (#3414) 1 year ago
UnrealEngine.gitignore Revert "add the *.VC.db to unreal engine ignore" 3 years ago
VVVV.gitignore ensure single trailing newline 8 years ago
VisualStudio.gitignore Revert #3706 4 months ago
Waf.gitignore Waf: Be more explicit in patterns 6 years ago
WordPress.gitignore Updated ignored list (#2972) 2 years ago
Xojo.gitignore Update Xojo.gitignore for changes to .obsolete 8 months ago
Yeoman.gitignore Create Yeoman.gitignore 8 years ago
Yii.gitignore Merge remote-tracking branch 'origin/master' into pr/506 8 years ago
ZendFramework.gitignore Remove double-spaced lines 4 years ago
Zephir.gitignore Added comments for Zephir 7 years ago

A collection of .gitignore templates

This is GitHub’s collection of .gitignore file templates. We use this list to populate the .gitignore template choosers available in the 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

We support a collection of templates, organized in this way:

  • The root folder contains templates in common use, to help people get started with popular programming languages and technologies. These define a meaningful set of rules to help get started, and ensure you are not committing unimportant files into your repository.
  • Global contains templates for various editors, tools and operating systems that can be used in different situations. It is recommended that you either add these to your global template or merge these rules into your project-specific templates if you want to use them permanently.
  • community contains specialized templates for other popular languages, tools and project, which don't currently belong in the mainstream templates. These should be added to your project-specific templates when you decide to adopt the framework or tool.

What makes a good template?

A template should contain a set of rules to help Git repositories work with a specific programming language, framework, tool or environment.

If it's not possible to curate a small set of useful rules for this situation, then the template is not a good fit for this collection.

If a template is mostly a list of files installed by a particular version of some software (e.g. a PHP framework), it could live under the community directory. See versioned templates for more details.

If you have a small set of rules, or want to support a technology that is not widely in use, and still believe this will be helpful to others, please read the section about specialized templates for more details.

Include details when opening pull request if the template is important and visible. We may not accept it immediately, but we can promote it to the root at a later date based on interest.

Please also understand that we can’t 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, it’s not because it’s not awesome.

Contributing guidelines

We’d love for 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 project’s homepage. Unless it’s extremely popular, there’s a chance the maintainers don’t know about or use the language, framework, editor, app, or project your change applies to.

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

  • Explain why you’re 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. It’s 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 is 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 you’re making, the more likely we’ll be to accept your contribution quickly.

Versioned templates

Some templates can change greatly between versions, and if you wish to contribute to this repository we need to follow this specific flow:

  • the template at the root should be the current supported version
  • the template at the root should not have a version in the filename (i.e. "evergreen")
  • previous versions of templates should live under community/
  • previous versions of the template should embed the version in the filename, for readability

This helps ensure users get the latest version (because they'll use whatever is at the root) but helps maintainers support older versions still in the wild.

Specialized templates

If you have a template that you would like to contribute, but it isn't quite mainstream, please consider adding this to the community directory under a folder that best suits where it belongs.

The rules in your specialized template should be specific to the framework or tool, and any additional templates should be mentioned in a comment in the header of the template.

For example, this template might live at community/DotNet/InforCRM.gitignore:

# gitignore template for InforCRM (formerly SalesLogix)
# website:
# Recommended: VisualStudio.gitignore

# Ignore model files that are auto-generated

# Ignore deployment files

# Force include portal SupportFiles

Contributing workflow

Here’s 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 fork’s 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.