Skip to content

added pycharm .idea and .iml files to python git ignore#3346

Closed
michalslowikowski00 wants to merge 2 commits into
github:masterfrom
michalslowikowski00:add-pycharm-files-to-python-gitignore
Closed

added pycharm .idea and .iml files to python git ignore#3346
michalslowikowski00 wants to merge 2 commits into
github:masterfrom
michalslowikowski00:add-pycharm-files-to-python-gitignore

Conversation

@michalslowikowski00

Copy link
Copy Markdown

Reasons for making this change:
There are missing files for PyCharm IDE: .idea and *.iml.

Links to documentation supporting these rule changes:
I couldn't find docs about why I should ignore these files, but here are two links with discussion about it.
https://intellij-support.jetbrains.com/hc/en-us/community/posts/115000154070-How-to-gitignore-idea-files
intellij-rust/intellij-rust#1570

If this is a new template:

@michalslowikowski00 michalslowikowski00 changed the title added pycharm files to python git ignore added pycharm .idea and .iml files to python git ignore Mar 24, 2020
@mik-laj

mik-laj commented Mar 24, 2020

Copy link
Copy Markdown

We maintain a Global/JetBrains.gitignore template here that covers everything you should need.

@potiuk

potiuk commented Mar 24, 2020

Copy link
Copy Markdown

But maybe it's worth to add it to assume that a lot of people want to use it ? there is no harm in it.

@mik-laj

mik-laj commented Mar 24, 2020

Copy link
Copy Markdown

I don't manage this project, so I don't have an opinion.Here is similar PR about Python + VSCode: #3317

@turbaszek

Copy link
Copy Markdown

I think it would be good to add it also to Golang .gitignore

@drothmaler

drothmaler commented Mar 25, 2020

Copy link
Copy Markdown
Contributor

The problem is, once you go down that road, you would have to add it to many more files...

  • WebStorm -> Node.gitignore
  • Rider -> VisualStudio.gitignore (that is actually more a DotNet.gitignore)
  • CLion -> C.gitignore, C++.gitignore, and probably more languages like Rust or D
  • Ruby -> Ruby.gitignore
  • AppCode -> Swift.gitignore, Objective-C.gitignore
  • GoLand -> Go.gitignore
  • PhpStorm -> to alle the PHP related gitignores (probably CakePHP, Composer, FuelPHP and many more...)
  • IntelliJ -> Java.gitignore - and all the other JVM-Languages...

And why not also add VSCode, or <nextGreatIdeOrEditor> ignores to all the files - because everybody uses it these day...? Same goes for the Operating System gitignore files...
But who is going to keep all of those in sync, when the new version of the tool is released?

... As you can see, just because 'a lot of people want to use it', doesn't mean it's a good idea, to mix it all together.

This repo is modular. There are small, maintainable gitignore files for Tools, Languages, BuildSystem, Editors, IDEs, OperatingSystems and probably more. And you can combine them, to tailor a custom gitignore specific for all your Projects needs (e.g. using gitignore.io).
I really like this principle, so I will continue to vote agains all the LetsCombineAllThingsTogether-PRs, popping up from time to time - because they will make it harder for us all in the long run...

@potiuk

potiuk commented Mar 25, 2020

Copy link
Copy Markdown

So why don't we describe this principle and link to gihub.io prominently in the README ? That would save a lot of hassle and there will be far less LetsCombineAllThingsTogether-PRs, I created PR for that #3348

@shiftkey

Copy link
Copy Markdown
Member

Thanks everyone for the discussion on this. I've been meaning to rewrite the README for a while to address some things but it keeps getting bumped down my priority queue. Hearing this context from everyone helps me to understand what I need to communicate to everyone.

I'm going to close out this PR given we have #3348 open for improving the README and #3349 to improve how the JetBrains products are listed here, stay tuned!

@BrianMSheldon

Copy link
Copy Markdown
Contributor

See #3451 for an optional solution

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants