Skip to content

Commit 22f1ff9

Browse files
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`.
1 parent 18aa6d8 commit 22f1ff9

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

Python.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,10 @@ dmypy.json
136136

137137
# Cython debug symbols
138138
cython_debug/
139+
140+
# PyCharm
141+
# JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
142+
# be found at https://github.com/github/gitignore/blob/master/Global/JetBrains.gitignore
143+
# and can be added to the global gitignore or merged into this file. For a more nuclear
144+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
145+
#.idea/

0 commit comments

Comments
 (0)