search

openhatch / open-source-comes-to-campus

Planning for improving Open Source Comes to Campus
31 stars 22 forks source link

make a .gitignore to avoid checking in unnecessary files #27

Closed codersquid closed 10 years ago

shaunagm commented 11 years ago

Hi Sheila, just to check - is this for the "Practicing Git" projects?

paulproteus commented 11 years ago

@codersquid if this is for "Practicing Git", then what should that file be? I ask earnestly because I'm not sure what kinds of files you would want to exclude.

codersquid commented 11 years ago

You may want to consider this invalid. I saw the *~ files and thought you had added them by accident, but I think they were on purpose so that people could learn about removing files. If that is the case, then close this as invalid.

paulproteus commented 11 years ago

Ah, right. Curious what @shaunagm thinks since she added them originally. I think they were indeed added by mistake fwiw.

shaunagm commented 11 years ago

Not sure how they were added, but they were definitely intentionally kept, as they're an issue in the projects. That said, they're especially confusing for windows users as the .html in index.html is not viewable in a windows file-browsing GUI while all of "index.html~" is, so when you say "open index.html" windows users almost invariably open the wrong file. For that reason alone I think they're worth removing. If we want to introduce this concept we can do it with "README.md~" since we never tell attendees to open README.md.

NicMcPhee commented 11 years ago

You might also consider documenting that their presence is intentional somewhere. I know that when I saw them my initial instinctive reaction was "Man, that's just sloppy and a bad example to set for students". Doing a little more digging I began to suspect they might be intentional, but being clear about that somewhere (maybe in a README?) might be useful.

shaunagm commented 10 years ago

We decided to include the "*~" files in the gitignore (see here https://github.com/openhatch/github-website-editing-demo/blob/master/.gitignore). While dealing with them is a useful exercise for some students, for a significant minority it's actively confusing.