toptal / gitignore

The largest collection of useful .gitignore templates

The largest collection of useful .gitignore templates

About

This project is also the canonical repository where https://www.gitignore.io template list comes from. Here are the reasons behind the need for this repository: https://blog.joeblau.com/gitignore-io-template-fork

Testing

This testing process ensures that https://www.gitignore.io template list contains all of the changes from GitHub's template list. The CI system will automatically listen to commits from GitHub and merge any changes.

1. Pre-requisites

pip install moban

2. Sync repository with GitHub and copy templates

./.github/scripts/sync-github.sh
moban

3. Make sure you don't commit files with blank lines or missing EOF line

./.github/scripts/check-whitespace.sh

Files

There are four file types that gitignore.io recognizes

1. Templates

   A .gitignore file is the foundation of all templates. Each .gitignore file contains gitignore information related to the title of the file. For example, Go.gitignore contains a gitignore template that is used when creating a project using the Go programming language.

   

2. Patch

   A .patch is a file to extend the functionality of a template. The source for some of the template files on toptal/gitignore come from github/gitignore. GitHub maintains strict contributing guidelines and the .patch file allows anyone to extend any of the templates to add extra template rules

   

3. Stack

   A .stack is a file that allows for the creation of code stacks (LAMP, MEAN, React Native). In today's development environment a .gitignore file is usually comprised of multiple technologies. A stack creates an elegant way to keep the stack up to date with child dependencies.

   

4. Order

   The order file simply ensure that if certain templates are requested, the order in which the templates are loaded is maintained.