Go to file
Daniel Johnson 7b22f8ab6c
Merge pull request #4081 from katexochen/main
Ignore go.work.sum
2024-05-10 15:56:00 -07:00
.github Adds a relationship question 2021-12-03 12:13:29 -08:00
Global Update Xcode.gitignore 2021-12-23 01:18:15 +01:00
community Ignore SQLite files 2022-05-06 11:23:14 +02:00
AL.gitignore Add .gitignore for Microsoft Business Central 2021-11-02 10:44:10 +01:00
Actionscript.gitignore Fix comments on same line causing ignore to break 2017-08-10 23:27:44 -04:00
Ada.gitignore ensure single trailing newline 2014-03-27 17:04:56 +01:00
Agda.gitignore Add MAlonzo directory. (#2978) 2019-03-08 08:47:43 -04:00
Android.gitignore Android Studio 2022-02-02 15:20:30 -06:00
AppEngine.gitignore Added template for Google App Engine 2015-01-15 19:05:19 -05:00
AppceleratorTitanium.gitignore Added Appcelerator Titanium .gitignore file. 2012-08-22 18:06:15 -07:00
ArchLinuxPackages.gitignore Add .jar, .exe and .msi 2015-05-28 12:37:43 +02:00
Autotools.gitignore Merge pull request #3652 from arthur-targaryen/patch-1 2021-06-09 21:32:08 -07:00
C++.gitignore added prerequisites for C and C++ 2016-06-29 13:33:32 -03:00
C.gitignore Update C.gitignore 2016-10-31 18:27:09 -04:00
CFWheels.gitignore add cfwheels gitignore 2011-02-21 18:02:55 -08:00
CMake.gitignore Ignore CMake FetchContent directory 2019-01-23 20:11:58 +00:00
CONTRIBUTING.md Trim trailing whitespace 2018-06-05 11:09:20 +07:00
CUDA.gitignore Add CUDA.gitignore 2015-03-14 17:29:54 -07:00
CakePHP.gitignore Update CakePHP.gitignore 2015-11-20 18:14:33 +01: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
CodeIgniter.gitignore fixes CodeIgniter.gitignore deleting a critical system file 2021-07-17 14:19:06 +02:00
CommonLisp.gitignore Update CommonLisp.gitignore 2016-12-27 12:12:30 -05:00
Composer.gitignore Fix link to go to current anchor 2017-10-27 17:55:29 -05:00
Concrete5.gitignore Update concrete5 gitignore (#3176) 2020-02-09 20:09:03 -04:00
Coq.gitignore Update Coq.gitignore 2021-04-13 10:39:58 -04:00
CraftCMS.gitignore Craft: update to follow official recs; add 'not necessary in v3' note 2018-06-21 22:25:43 -04:00
D.gitignore Update D.gitignore 2016-06-06 22:23:51 +03:00
DM.gitignore ensure single trailing newline 2014-03-27 17:04:56 +01:00
Dart.gitignore Update Dart.gitignore 2021-05-07 11:59:24 -07:00
Delphi.gitignore Update Delphi.gitignore 2018-10-12 10:12:55 -03:00
Drupal.gitignore Update Drupal.gitignore with upstream conventions: prefix /web for drupal code; remove deprecated simpletest directory; allow project composer.json|lock at root; add /vendor, composer, robo, drush and drupal scripts to root 2020-04-28 18:56:15 +01:00
EPiServer.gitignore ensure single trailing newline 2014-03-27 17:04:56 +01:00
Eagle.gitignore Eagle: Remove duplicate entry 2018-06-18 12:35:46 +07:00
Elisp.gitignore add final newline 2016-10-27 03:19:31 +11:00
Elixir.gitignore ignore files generated by ElixirLS 2018-11-06 11:32:22 +11:00
Elm.gitignore Ignore elm-stuff project-wide 2016-07-28 10:18:33 +02:00
Erlang.gitignore Add rebar3 tool files and directories (#3178) 2019-09-16 11:12:42 -03:00
ExpressionEngine.gitignore Merge pull request #488 from nanadevelopment/eeConfigAdd 2013-11-11 05:37:55 -08:00
ExtJs.gitignore Adds some files 2017-09-07 18:55:03 +02: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
FlaxEngine.gitignore Create .gitignore for Flax Engine 2021-07-29 11:47:29 +06: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 update FuelPHP.gitignore 2014-12-08 21:05:58 +09:00
GWT.gitignore GWT: Remove duplicate entry 2018-06-18 12:38:20 +07:00
Gcov.gitignore Capitalise initial letter in template filenames for consistency/sorting 2015-01-07 15:16:27 +11:00
GitBook.gitignore Correct URL for NPM URL reference 2015-02-05 10:21:40 -06:00
Go.gitignore Ignore go.work.sum 2022-05-31 18:40:47 +02:00
Godot.gitignore Add .godot/ folder to Godot.gitignore for Godot 4 2021-05-16 15:46:38 -04:00
Gradle.gitignore Update Gradle.gitignore 2022-01-30 15:45:09 -08:00
Grails.gitignore Adding additional comments 2014-09-08 00:52:39 -04:00
Haskell.gitignore Add *.hie to Haskell.gitignore (#3120) 2019-07-21 10:47:04 -03:00
IGORPro.gitignore Create IGORPro.gitignore 2014-12-03 11:33:11 +01:00
Idris.gitignore Update .gitignore for Idris 2 2021-03-15 14:32:59 +06:00
JBoss.gitignore correct capitalization problems and add Octave which link to MATLAB 2018-11-26 22:02:40 +11:00
JENKINS_HOME.gitignore Improved JENKINS_HOME example (#3332) 2020-03-11 10:03:44 -03:00
Java.gitignore Add replay_pid* to Java.gitignore 2021-11-14 22:57:55 +06:00
Jekyll.gitignore Ignore .bundle and vendor per official Jekyll documentation 2021-12-14 16:47:37 -08:00
Joomla.gitignore Updating Joomla.gitignore to Joomla! 3.9.8 (#3090) 2019-06-23 10:13:21 -03:00
Julia.gitignore Add more standard ignored files for Julia (#2992) 2019-03-14 13:41:28 -03:00
KiCad.gitignore Merge pull request #3805 from wc7086/patch-1 2021-12-10 16:36:58 -08:00
Kohana.gitignore ensure single trailing newline 2013-10-06 14:40:01 +02:00
Kotlin.gitignore Symlink Kotlin.gitignore to Java.gitignore 2016-02-25 22:49:56 +00:00
LICENSE Use the exact CC-0 license text 2016-10-28 11:18:45 -04:00
LabVIEW.gitignore Ignore the .cache folder for LabVIEW projects 2018-05-09 13:28:57 -05:00
Laravel.gitignore Update Laravel.gitignore (#3098) 2019-06-27 12:49:08 -03:00
Leiningen.gitignore Update .gitignore with .cpcache 2018-03-18 10:40:50 +05:30
LemonStand.gitignore ensure single trailing newline 2013-10-06 14:40:01 +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 Remove patch files from repo 2018-09-25 16:26:00 +02:00
Maven.gitignore Ignore Eclipse .project and .classpath when using build tools Maven or Gradle 2021-12-11 11:32:26 -05:00
Mercury.gitignore Mercury.gitignore: Add Mercury.modules 2015-01-09 13:06:58 +08:00
MetaProgrammingSystem.gitignore Grammar/formatting tweak to comments 2014-06-12 11:42:57 +10:00
Nanoc.gitignore Nanoc: Ignore tmp/nanoc/, not tmp/ 2017-08-29 23:23:24 +02:00
Nim.gitignore Updated Nim.gitignore (#3172) 2019-09-10 11:58:47 -03:00
Node.gitignore Add Docusaurus files to Node.gitignore 2021-12-23 14:53:27 +08:00
OCaml.gitignore Update OCaml.gitignore (#3010) 2019-03-21 14:10:28 -03:00
Objective-C.gitignore Improving the documentation of Objective-C and Swift files (#3133) 2019-08-07 09:23:05 -03:00
Opa.gitignore Added Opa.gitignore 2012-03-03 02:08:17 +01:00
OpenCart.gitignore excluding vqmod cache files and logs 2016-10-15 11:44:22 +00:00
OracleForms.gitignore added gitignore for Oracle Forms development 2012-03-19 16:46:57 -04:00
Packer.gitignore Fix typos 2020-08-30 19:21:51 -05:00
Perl.gitignore Fix typo of Perl.gitignore 2022-02-07 19:05:49 +09:00
Phalcon.gitignore Remove trailing asterisks in Phalcon rules 2014-03-21 12:57:41 +11:00
PlayFramework.gitignore Added /project/project to PlayFramework.gitignore 2017-02-22 08:43:06 -08:00
Plone.gitignore Covered by global vim template 2013-11-12 15:09:20 +07:00
Prestashop.gitignore Update for Prestashop 1.7 (#3261) 2020-03-11 09:10:57 -03:00
Processing.gitignore Ignore transpiled .java and .class files (#3016) 2019-03-27 08:31:02 -03:00
PureScript.gitignore Update PureScript adding .spago (#3278) 2020-01-21 08:57:39 -04:00
Python.gitignore Add .pdm-build/ 2023-12-28 14:21:54 +01:00
Qooxdoo.gitignore Add gitignore for qooxdoo apps 2011-02-21 18:08:18 -08:00
Qt.gitignore Remove trailing whitespace 2021-07-11 13:03:23 +08:00
R.gitignore Merge pull request #3792 from jl5000/patch-1 2021-12-10 16:11:17 -08:00
README.md Merge pull request #3854 from AnilSeervi/patch-1 2021-12-10 16:06:20 -08:00
ROS.gitignore Added ignore for files created by `catkin_make_isolated` 2018-01-26 11:32:59 +01:00
Racket.gitignore Update Racket.gitignore 2022-02-01 08:44:27 +00:00
Rails.gitignore Ignore Rails .env according recomendations 2021-10-28 04:52:49 -03:00
Raku.gitignore Changes the name of Perl 6 to Raku (#3312) 2020-02-19 14:10:09 -04:00
RhodesRhomobile.gitignore Add Rhodes mobile application framework gitignore 2010-11-10 03:44:16 +08:00
Ruby.gitignore Ruby: ignore RuboCop remote inherited config files (#3197) 2019-10-04 09:19:47 -03:00
Rust.gitignore Rust: ignore .pdb files 2021-04-27 09:54:38 -04:00
SCons.gitignore Update SCons.gitignore (#3001) 2019-03-18 09:14:04 -03:00
Sass.gitignore Add all sourcemap file formats 2018-05-24 00:12:37 -05:00
Scala.gitignore add scala jvm crash files 2021-04-21 13:37:41 +02:00
Scheme.gitignore Add Scheme.gitignore 2015-08-22 20:56:50 +09:00
Scrivener.gitignore Added new checksums and allows for relative directories (#3128) 2019-09-20 12:59:19 -03: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
Smalltalk.gitignore Merge pull request #2027 from rejurime/dolphin-smalltalk 2018-11-23 14:54:50 -04:00
Stella.gitignore Capitalise initial letter in template filenames for consistency/sorting 2015-01-07 15:16:27 +11:00
SugarCRM.gitignore ensure the following ! rules are included 2017-05-15 19:31:13 +10:00
Swift.gitignore Improving the documentation of Objective-C and Swift files (#3133) 2019-08-07 09:23:05 -03:00
Symfony.gitignore Ignore logs for Symfony4 2018-08-08 22:39:04 +02:00
SymphonyCMS.gitignore added symphony and workspace/uploads dir 2012-04-11 11:39:01 +03:00
TeX.gitignore Merge pull request #3752 from lafeychine/TikZplot 2021-12-10 16:02:53 -08:00
Terraform.gitignore Merge pull request #3965 from imomaliev/patch-1 2022-02-10 20:12:42 -08: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
TwinCAT3.gitignore After adding the new product "TF3680 - TC3 Filter" as a reference, some new files were automatically generated after compilation: 2020-05-26 16:17:55 +02:00
Typo3.gitignore Merge pull request #1646 from josefglatz/TYPO3-improvements 2018-06-17 16:06:06 -03:00
Unity.gitignore Merge branch 'main' into patch-1 2021-12-10 14:00:54 -08:00
UnrealEngine.gitignore Revert "add the *.VC.db to unreal engine ignore" 2018-06-18 12:32:46 +07:00
VVVV.gitignore ensure single trailing newline 2014-03-27 17:04:56 +01:00
VisualStudio.gitignore [VisualStudio.gitignore] remove a trailing space 2022-01-26 23:58:07 +08:00
Waf.gitignore Waf: Be more explicit in patterns 2016-03-24 13:26:58 -04:00
WordPress.gitignore Replace references of this repo's "master" branch 2021-12-06 23:39:54 +01:00
Xojo.gitignore Update Xojo.gitignore for changes to .obsolete 2021-02-21 10:14:43 -05: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 Remove double-spaced lines 2017-09-12 01:29:04 -04:00
Zephir.gitignore Added comments for Zephir 2014-06-21 20:02:16 +04:00

README.md

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

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 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 guidelines

Wed 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 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 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 youre making, the more likely well 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: https://www.infor.com/product-summary/cx/infor-crm/
#
# Recommended: VisualStudio.gitignore

# Ignore model files that are auto-generated
ModelIndex.xml
ExportedFiles.xml

# Ignore deployment files
[Mm]odel/[Dd]eployment

# Force include portal SupportFiles
!Model/Portal/*/SupportFiles/[Bb]in/
!Model/Portal/PortalTemplates/*/SupportFiles/[Bb]in

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 main 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

CC0-1.0.