From 47487469e9d131047c8dc288618241ea9980a068 Mon Sep 17 00:00:00 2001
From: Jeremy Stanley <fungi@yuggoth.org>
Date: Fri, 5 Oct 2018 18:25:22 +0000
Subject: [PATCH] Dissuade .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. Add a comment block explaining this, for
clarity, and remove the one current editor-specific entry present.

We can, and should of course, continue to list files created by the
tools recommended by our workflow (test frameworks, documentation
and packaging builds, et cetera).

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

Change-Id: Ib79f8e857cc71d5e7ddbaf856e29f2548c624f52
---
 .gitignore                                      | 11 +++++++++++
 puppet-{{cookiecutter.project_name}}/.gitignore | 12 +++++++++++-
 2 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index f6f9dfa..1d020aa 100644
--- a/.gitignore
+++ b/.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'
+
 .bundled_gems/
 default-config.yaml
 puppet-whazz/
diff --git a/puppet-{{cookiecutter.project_name}}/.gitignore b/puppet-{{cookiecutter.project_name}}/.gitignore
index 6b254e3..149bf57 100644
--- a/puppet-{{cookiecutter.project_name}}/.gitignore
+++ b/puppet-{{cookiecutter.project_name}}/.gitignore
@@ -1,7 +1,17 @@
+# 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'
+
 Gemfile.lock
 spec/fixtures/modules/*
 spec/fixtures/manifests/site.pp
-*.swp
 pkg
 vendor/
 /openstack/