gitignore/README.md

85 lines
3.9 KiB
Markdown
Raw Normal View History

# A collection of `.gitignore` templates
2010-11-08 21:21:45 +01:00
This is GitHubs collection of [`.gitignore`][man] file templates.
We use this list to populate the `.gitignore` template choosers available
in the GitHub.com interface when creating new repositories and files.
2010-11-08 21:43:25 +01:00
For more information about how `.gitignore` files work, and how to use them,
the following resources are a great place to start:
2010-11-08 23:56:21 +01:00
- The [Ignoring Files chapter][chapter] of the [Pro Git][progit] book.
- The [Ignoring Files article][help] on the GitHub Help site.
- The [gitignore(5)][man] manual page.
2010-11-08 21:52:45 +01:00
[man]: http://git-scm.com/docs/gitignore
[help]: https://help.github.com/articles/ignoring-files
[chapter]: http://git-scm.com/book/en/Git-Basics-Recording-Changes-to-the-Repository#Ignoring-Files
[progit]: http://git-scm.com/book
2010-11-08 21:46:40 +01:00
## 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/`](./Global) directory.
## Contributing guidelines
2010-11-09 01:11:36 +01:00
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.
2015-09-23 18:56:15 +02:00
- **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.
2015-09-23 18:56:15 +02:00
- **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.
2015-09-23 18:56:15 +02:00
- **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.
If a template is mostly a list of files installed by a particular version of
some software (e.g. a PHP framework) then it's brittle and probably no more
helpful than a simple `ls`. If it's not possible to curate a small set of
useful rules, then the template might not be a good fit for this collection.
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
2010-11-09 01:11:36 +01:00
Heres how we suggest you go about proposing a change to this project:
2010-11-09 01:11:36 +01:00
1. [Fork this project][fork] to your account.
2. [Create a branch][branch] for the change you intend to make.
3. Make your changes to your fork.
4. [Send a pull request][pr] 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.
[fork]: https://help.github.com/articles/fork-a-repo/
[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository
[pr]: https://help.github.com/articles/using-pull-requests/
2010-11-09 01:11:36 +01:00
## License
2010-11-09 01:11:36 +01:00
2015-12-14 03:49:50 +01:00
[CC0-1.0](./LICENSE).