Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
Add JetBrains note for PyCharm to Python.gitignore #3451
+7
−0
Conversation
First and foremost I think that requiring such a complicated gitignore for JetBrains IDEs is a failure on JetBrains part in structuring their project setting. I also feel that it should be included in the `Python.gitignore` due to its popularity and due to the frequency of requests. A quick search for `PyCharm` PRs shows 81 closed PRs requesting it be added and if searching for `.idea` you can see many more have been requested. However I understand the maintenance burden in including it when a user can manually merge the two files themselves so I understand why the maintainers have opted to maintain it seperately. The main problem I see is that with many people adding the `Python.gitignore` at project creation through the Github UI and the `JetBrains.gitignore` being in the Global folder and makes it less discoverable than it should be. This PR adds a comment for people adding the `Python.gitignore` directing them to the global `JetBrains.gitignore` which should solve this issue in a way that is acceptable for the maintainers, since comment-only sections already exist for `pyenv` and `pipenv`.
This was referenced Sep 25, 2020
Closed
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Reasons for making this change:
First and foremost I think that requiring such a complicated gitignore for JetBrains IDEs is a failure on JetBrains part in structuring their project setting. I also feel that it should be included in the
Python.gitignoredue to its popularity and due to the frequency of requests. A quick search forPyCharmPRs shows 81 closed PRs requesting it be added and if searching for.ideayou can see many more have been requested. However I understand the maintenance burden in including it when a user can manually merge the two files themselves so I understand why the maintainers have opted to maintain it seperately.The main problem I see is that with many people adding the
Python.gitignoreat project creation through the Github UI and theJetBrains.gitignorebeing in the Global folder makes it less discoverable than it should be.This PR adds a comment to the
Python.gitignoredirecting users to the globalJetBrains.gitignore. I believe this solves the issue in a way that is acceptable for the maintainers since comment-only sections already exist forpyenvandpipenv.Links to documentation supporting these rule changes:
Closed PyCharm and .idea PRs
pyenv comment
pipenv comment