Skip to content

Commit

Permalink
Dissuade .gitignore references to personal tools
Browse files Browse the repository at this point in the history
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: I05aae31f36cf6ff14da240d5a196b40b7e086d1c
  • Loading branch information
zhongshengping committed Oct 8, 2018
1 parent d53fd0c commit 59033f8
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -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/
Expand All @@ -6,7 +17,6 @@ spec/fixtures/
.bundle/
coverage/
.idea/
*.swp
*.iml
/openstack
/log
Expand Down

0 comments on commit 59033f8

Please sign in to comment.