Skip to content

Commit da86f5e

Browse files
committed
Clean up .gitignore references to personal tools
Developers run all sorts of different tools within Git repositories, any of which can leave their own special trashfiles all over the place. We can't every hope to catalog them all, so better to recommend developers simply configure a global core.excludesfile to filter the irrelevant files which tend to get created by their personal choice of tools. To this end, remove the long-standing sections for "Mr Developer" and "Editors" since their mere existence here sends the signal that we welcome (and have time to review) additions for any old tool someone ever might happen to try. Also add a comment block explaining this, for clarity. We can, and should of course, continue to list files created by the tools recommended by our workflow (test frameworks called from tox, documentation and packaging builds, et cetera). Change-Id: Ib58a57267b064e4142686de6c37a70dbff04b9a7
1 parent 69779bf commit da86f5e

File tree

2 files changed

+24
-20
lines changed

2 files changed

+24
-20
lines changed

.gitignore

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
# Add patterns in here to exclude files created by tools integrated with this
2+
# repository, such as test frameworks from the project's recommended workflow,
3+
# rendered documentation and package builds.
4+
#
5+
# Don't add patterns to exclude files created by preferred personal tools
6+
# (editors, IDEs, your operating system itself even). These should instead be
7+
# maintained outside the repository, for example in a ~/.gitignore file added
8+
# with:
9+
#
10+
# git config --global core.excludesfile '~/.gitignore'
11+
12+
# Bytecompiled Python
113
*.py[cod]
214

315
# C extensions
@@ -32,11 +44,6 @@ nosetests.xml
3244
# Translations
3345
*.mo
3446

35-
# Mr Developer
36-
.mr.developer.cfg
37-
.project
38-
.pydevproject
39-
4047
# Complexity
4148
output/*.html
4249
output/*/index.html
@@ -48,11 +55,6 @@ doc/build
4855
AUTHORS
4956
ChangeLog
5057

51-
# Editors
52-
*~
53-
.*.swp
54-
.*sw?
55-
5658
# Cookiecutter
5759
output/
5860
boilerplate/

{{cookiecutter.repo_name}}/.gitignore

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
# Add patterns in here to exclude files created by tools integrated with this
2+
# repository, such as test frameworks from the project's recommended workflow,
3+
# rendered documentation and package builds.
4+
#
5+
# Don't add patterns to exclude files created by preferred personal tools
6+
# (editors, IDEs, your operating system itself even). These should instead be
7+
# maintained outside the repository, for example in a ~/.gitignore file added
8+
# with:
9+
#
10+
# git config --global core.excludesfile '~/.gitignore'
11+
12+
# Bytecompiled Python
113
*.py[cod]
214

315
# C extensions
@@ -34,11 +46,6 @@ nosetests.xml
3446
# Translations
3547
*.mo
3648

37-
# Mr Developer
38-
.mr.developer.cfg
39-
.project
40-
.pydevproject
41-
4249
# Complexity
4350
output/*.html
4451
output/*/index.html
@@ -50,10 +57,5 @@ doc/build
5057
AUTHORS
5158
ChangeLog
5259

53-
# Editors
54-
*~
55-
.*.swp
56-
.*sw?
57-
5860
# Files created by releasenotes build
5961
releasenotes/build

0 commit comments

Comments
 (0)