New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added .idea/ to gitignore, to cover cases where people are using a Jetbrains text editor #1497

Merged
merged 1 commit into from Sep 20, 2018

Conversation

Projects
None yet
3 participants
@joeflack4
Contributor

joeflack4 commented Sep 19, 2018

Summary of changes

Added .idea/ to gitignore, to cover cases where people are using a Jetbrains text editor

@pganssle pganssle added the trivial label Sep 20, 2018

@pganssle pganssle merged commit eaa86ef into pypa:master Sep 20, 2018

5 checks passed

codecov/patch Coverage not affected when comparing 4f86e36...1eadacc
Details
codecov/project 81.44% remains the same compared to 4f86e36
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
deploy/netlify Deploy preview ready!
Details
@pganssle

This comment has been minimized.

Member

pganssle commented Sep 20, 2018

@joeflack4 Thanks for this PR! Always nice when you don't have to think too hard about whether or not to merge something ;)

@jaraco

This comment has been minimized.

Member

jaraco commented Sep 20, 2018

Sorry to be a contrarian, but I've probably rejected this idea before. It doesn't make sense to update every project's .gitignore for every developer's environment. This preference should be added to each JetBrains developers global ignores (for example, here's mine). I also encourage Python developers to put Python ignores there. In my opinion, .gitignore for a project should include ignores unique to that project (and little more).

I won't revert this change. I've stopped trying to keep the ignores trim. Just wanted to share my opinion for perhaps a different perspective.

@pganssle

This comment has been minimized.

Member

pganssle commented Sep 20, 2018

@jaraco I did consider this, and honestly I'd probably like to reorganize the .gitignore so it's clear what things should and shouldn't be in there and why each rule is inplace. Though we also do have some emacs-specific stuff in .gitignore as well, so this isn't the first "editor detritus" rule.

The reasons I think it's probably not so bad are:

  1. We definitely know we don't want to check in a file called .idea at any point in the future. We could ask everyone to configure their git correctly (and ideally they would do that as well because not every project will add every stupid editor file to their .gitignore), but this guarantees that if someone does it wrong, we don't have to bother removing it or telling them to remove it.
  2. It doesn't hurt anything (at least not at the moment) - again we never would want to check this file in, and even if we added the "editor detritus" for the top 50 editors, we'd probably never notice an impact in readability of the .gitignore or the speed of git commands.

Ideally editors and file systems wouldn't pollute working directories with .project or .idea or .DS_STORE or folder.jpg or whatever, and even if they did ideally people would configure their environments correctly, I agree, but it's probably easier to do this once than to deal with it every time it comes up.

@joeflack4

This comment has been minimized.

Contributor

joeflack4 commented Sep 21, 2018

Thanks very much for the merge. I didn't expect this fast of a response, and these high quality comments in reply to the humble PR. Thanks!

@jaraco Also, I didn't even know about Jetbrains global ignores. Did you mean to have linked this though? If so, I do not see where the example is.

Also on other .gitignore variations, there's also this as a possibility?:

# syntax: glob
.*
!.codecov.yml
!.github/
!.gitignore
!.readthedocs.yml
!.readthedocs.yml
bin
build
dist
docs/build
include
lib
distribute.egg-info
setuptools.egg-info
*.egg
*.py[cod]
*.swp
*~
@jaraco

This comment has been minimized.

Member

jaraco commented Sep 21, 2018

Did you mean to have linked this?

No; I'll correct corrected.

@jaraco

This comment has been minimized.

Member

jaraco commented Sep 21, 2018

FYI, I cut a release with this change just to do a demo of the release workflow. I wouldn't normally cut a release for a change that doesn't affect the published distribution.

@joeflack4

This comment has been minimized.

Contributor

joeflack4 commented Sep 23, 2018

Thanks @jaraco ! I'll use this.

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