From 947c7c97766ac60d7e42889996aa4b0ab9f527ee Mon Sep 17 00:00:00 2001
From: Jeremy Stanley <fungi@yuggoth.org>
Date: Fri, 5 Oct 2018 18:06:06 +0000
Subject: [PATCH] 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).

This change is a port of Ib58a57267b064e4142686de6c37a70dbff04b9a7
from the openstack-dev/cookiecutter repository.

Change-Id: I79569d8693937c436056e90116cc3f59b4a34507
---
 .gitignore                            | 22 ++++++++++++----------
 {{cookiecutter.repo_name}}/.gitignore | 15 +++++++++++----
 2 files changed, 23 insertions(+), 14 deletions(-)

diff --git a/.gitignore b/.gitignore
index 08b7b97..0bd65dc 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,15 @@
+# Add patterns in here to exclude files created by tools integrated with this
+# repository, such as test frameworks from the project's recommended workflow,
+# rendered documentation and package builds.
+#
+# Don't add patterns to exclude files created by preferred personal tools
+# (editors, IDEs, your operating system itself even). These should instead be
+# maintained outside the repository, for example in a ~/.gitignore file added
+# with:
+#
+# git config --global core.excludesfile '~/.gitignore'
+
+# Bytecompiled Python
 *.py[cod]
 
 # C extensions
@@ -32,11 +44,6 @@ nosetests.xml
 # Translations
 *.mo
 
-# Mr Developer
-.mr.developer.cfg
-.project
-.pydevproject
-
 # Complexity
 output/*.html
 output/*/index.html
@@ -48,11 +55,6 @@ doc/build
 AUTHORS
 ChangeLog
 
-# Editors
-*~
-.*.swp
-.*sw?
-
 # Cookiecutter
 output/
 boilerplate/
diff --git a/{{cookiecutter.repo_name}}/.gitignore b/{{cookiecutter.repo_name}}/.gitignore
index 490f3ce..b0dbe83 100644
--- a/{{cookiecutter.repo_name}}/.gitignore
+++ b/{{cookiecutter.repo_name}}/.gitignore
@@ -1,3 +1,14 @@
+# Add patterns in here to exclude files created by tools integrated with this
+# repository, such as test frameworks from the project's recommended workflow,
+# rendered documentation and package builds.
+#
+# Don't add patterns to exclude files created by preferred personal tools
+# (editors, IDEs, your operating system itself even). These should instead be
+# maintained outside the repository, for example in a ~/.gitignore file added
+# with:
+#
+# git config --global core.excludesfile '~/.gitignore'
+
 AUTHORS
 ChangeLog
 build
@@ -8,10 +19,7 @@ npm-debug.log
 releasenotes/build
 {{ cookiecutter.module_name }}/test/.secret_key_store
 .coverage*
-.idea
 .jshintrc
-.project
-.pydevproject
 .settings
 .tox
 .venv
@@ -19,5 +27,4 @@ releasenotes/build
 *.lock
 *.mo
 *.py[cod]
-*.swp
 *nose_results.html