From 22f1ff9ac0d54f7d477f2f266b4c0ba11dbb73e8 Mon Sep 17 00:00:00 2001 From: BrianMSheldon Date: Wed, 24 Jun 2020 15:47:11 -0400 Subject: [PATCH] Add JetBrains note for PyCharm to Python.gitignore 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`. --- Python.gitignore | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Python.gitignore b/Python.gitignore index a81c8ee1..92ff2c4b 100644 --- a/Python.gitignore +++ b/Python.gitignore @@ -136,3 +136,10 @@ dmypy.json # Cython debug symbols cython_debug/ + +# PyCharm +# JetBrains specific template is maintainted in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/master/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/