Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

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

Closed
wants to merge 2 commits into from

4 participants

Hans Christian Reinl Roy R. Nicolas Gallagher Mathias Bynens
Hans Christian Reinl
Owner

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?

Hans Christian Reinl 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
Nicolas Gallagher
Owner

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

Hans Christian Reinl
Owner

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.

Roy R.

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.

Nicolas Gallagher
Owner

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

Hans Christian Reinl
Owner

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

Hans Christian Reinl drublic closed this pull request from a commit
Hans Christian Reinl 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
Hans Christian Reinl drublic closed this in 2a60c6b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jun 10, 2012
  1. Hans Christian Reinl

    Add comment on where to find more information on .gitignore

    drublic authored
    This solves some issues we had with including a lot of extensions for files that are created by certain IDEs and editors.
  2. Hans Christian Reinl
This page is out of date. Refresh to see the latest.
Showing with 2 additions and 0 deletions.
  1. +2 −0  .gitignore
2  .gitignore
View
@@ -1,3 +1,5 @@
+# Find out how to create a global .gitignore: http://h5bp.com/ae
+
# Numerous always-ignore extensions
*.diff
*.err
Something went wrong with that request. Please try again.