Put simply, gitignore.io is a tool that is so profoundly helpful that I've forgotten what life was like without it.
Its purpose is simple: for any project you're working on, it'll generate a valid
.gitignore file for you. All you need to do is use the autocomplete box provided to describe the type of project you're working on:
A .gitignore file is used to tell git to exclude files from being added to a given repo. Each line of the file represents a filename, directory, or pattern. When git looks for changes in your working directory, it will automatically ignore any file that matches an entry in your .gitignore file.
From there, you'll hit the
Create button, which will bring you to a page that displays nothing but the raw text which you'll need to add to your project's
.gitignore. If you selected just
react, for example this is what you'd see on the next page:
1# Created by https://www.toptal.com/developers/gitignore/api/react2# Edit at https://www.toptal.com/developers/gitignore?templates=react34### react ###5.DS_*6*.log7logs8**/*.backup.*9**/*.back.*1011node_modules12bower_components1314*.sublime*1516psd17thumb18sketch1920# End of https://www.toptal.com/developers/gitignore/api/react
That's all there is to it, too! I use it on the vast majority of projects I work on, new and old, and as far as I can tell, it hasn't let me down in any meaningful way.
It's Open Source!
One of the reasons I like this tool so much is that it gets better the more people use it. Is it missing support for a project type that you work with? Go ahead and submit a Pull Request, and it may be integrated into the product one day. Or, if you're not quite comfortable with a full-on PR, you can start the discussion in an issue on the repo. Maybe something isn't working like you'd expect -- and it's worth pitching in your two cents in the discussion on an open issue. All of that is contributing to Open Source -- don't forget!
Gitignore.io is a great example of a successful Open Source tool born out of the desire for an improved developer workflow. It currently appears to be operated by TopTal, a company that helps freelancers find work.
(note for transparency: I have no connection to TopTal, and this is not a
sponsored post. I
do (update: 11/2020) used to
, which is a creative staffing agency. If you're looking for work, give
them a look!).
There's a CLI
If you prefer it, there's a CLI which will help you generate gitignore files, powered by this same project. I can't say I've used it, but I know some of you will want to give it a go, so it's worth mentioning
There's other options, too
If you don't find gitignore.io particularly appealing, there's always other ways to cretae your
.gitignore file. You can write it by hand, or grab one from another project you work on. GitHub also maintains a repo of popular gitignore files, which seems to be updated quite frequently as well.
Was this helpful?
If you found this useful, I'd love it if you subscribed to my mailing list. Details are below!