Update .gitignore based on IntelliJ docs

[tmckenzie51]

updated based on IntelliJ documentation

What was wrong?

.idea/* listed in .gitignore encompassed .idea files that we want to share rather than ignore.

Related to : #50 (comment)

How was it fixed?

Specific .idea files were listed in .gitignore based on IntelliJ documentation here.

Cute Animal Picture

[tmckenzie51]

@carver I've updated the .gitignore files here based on the IntelliJ documentation. I noticed that 2 specific files that I intended to ignore in a previous PR, specifically .idea/inspectionProfiles/* were not included in the IntelliJ docs to be ignored, so I included them in an 'Other IDEA - uncomment if necessaary' section, as I wasn't sure how to address them. Should I keep that part or should I delete it?

[carver]

This line looks specific to one project, which seems wrong for going into a template.

Also, I take it that you do actually want to commit some files in .idea/ and that's why the nitpicking ignore file here? It makes me sad that it adds so much clutter :/ . Also, I'm not sure we want new contributors accidentally adding (any of) their .idea files by default across all projects based on this template.

I'll think about it a bit.

[tmckenzie51]

Oops, thanks for catching that. I've generalized the file name as idea/*.iml. I also uncommented this section, instead saying "Comment out if not using auto-import" to prevent new contributors from accidentally adding their idea/*.iml files. It is still a bit of clutter. I can remove the new comment from the file if you think it isn't necessary.

[carver]

Can you give an example of an .idea/ file that we do want to commit into the repo?

[tmckenzie51]

@carver According to the IntelliJ docs, "All the files under the .idea directory in the project root except the workspace.xml, usage.statistics.xml, and tasks.xml files and the shelf directory which store user-specific settings" should be shared. In my PR in the py_ecc library two .idea/inspectionProfiles/* files were added. Perhaps these two files might count as examples, but I'm actually not sure of the purpose of the files. I have them listed in the .gitignore file here under "Other IDEA - uncomment if necessary" section. What do you think about this?

[pacrob]

Closing as stale. Please file a new issue if needed.