openstack/puppet-openstack-cookiecutter
Code Issues Proposed changes

Dissuade .gitignore references to personal tools

Browse Source 
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
This commit is contained in:
Jeremy Stanley 2018-10-05 18:25:22 +00:00
parent 54af2a6048
commit 47487469e9
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
.gitignore vendored
View File

@ -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/ .bundled_gems/
default-config.yaml default-config.yaml
puppet-whazz/ puppet-whazz/

12
puppet-{{cookiecutter.project_name}}/.gitignore vendored
View File

@ -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 Gemfile.lock
spec/fixtures/modules/* spec/fixtures/modules/*
spec/fixtures/manifests/site.pp spec/fixtures/manifests/site.pp
*.swp
pkg pkg
vendor/ vendor/
/openstack/ /openstack/