From adc4f3fc3c60ea25db2a9856b4f62e5fdb973194 Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Mon, 8 Oct 2018 11:47:08 +0800 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: Ifb58f6a5362d6d8177b6ef2a1def2b997153ca46 --- .gitignore | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index bcd888b60..2a455e079 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' + pkg/ Gemfile.lock vendor/ @@ -8,9 +19,9 @@ spec/fixtures/manifests .bundle*/ coverage/ .idea/ -*.swp *.iml openstack/ + # Files created from releasenotes build releasenotes/build .tox