Add comment on where to find more information on .gitignore #1120

Closed
wants to merge 2 commits into
from

4 participants

@drublic
H5BP member

This comment in the .gitignore-file is supposed to solve some issues we had lately (#1065, #1070, #1073) with including a lot of extensions for files that are created by certain IDEs and editors. It should encourage users to set up a global .gitignore rather then relying on the HTML5 Boilerplate's .gitignore file.
This is a suggestion by @kvakes in #1065.

I'm all open to change this comment or the link where it goes.
It would be nice to have this link shortened with h5bp.com.

Any thoughts?

@drublic drublic Add comment on where to find more information on .gitignore
This solves some issues we had with including a lot of extensions for files that are created by certain IDEs and editors.
00bbc6d
@necolas
H5BP member

Could keep this a bit shorter, e.g., "Find out how to create a global .gitignore: http://h5bp.com/ae"

@drublic
H5BP member

I think the main goal is to let the user know where he/she can find out more about .gitignore. This is a bit more than the global .gitignore I think.
But it's ok with me to change the comment.

@tchalvak

May I just recommend trying to clarify that the "global" gitignore be termed something like a "all-git-repo" gitignore or something as explicit as possible? I use git heavily but didn't get the distinction at a glance, even the github article when you first view only uses the word "global" repeatedly in place of an explanation of the behavior. I have suggested some clarifying language to github for that article as well, but who knows if they'll act on that suggestion.

@necolas
H5BP member

I'd like to include just a short comment linking off to more info.

@mathiasbynens
H5BP member

Short URL: http://h5bp.com/ae

@drublic
H5BP member

Here is an update with @necolas' shorter version of the comment and the short-link. Thanks, @mathiasbynens :)

@drublic drublic added a commit that closed this pull request Jun 11, 2012
@drublic drublic Add a comment and link to more .gitignore info
A repository's `.gitignore` should be focused on ignoring files within
the repo that we do not want to be committed. For example, a build
directory.

A global ignore is a better place for ignoring OS-level files, editor
extensions, and files that you are always likely to want ignored (e.g.
zip).

Close #1065
Close #1120
2a60c6b
@drublic drublic closed this in 2a60c6b Jun 11, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment