Skip to content

Commit

Permalink
Clean up .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.

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 I1b41efac219fca44e2548fc36633724d0ecfc0cb
from the openstack-dev/oslo-cookiecutter repository.

Change-Id: Ief8b0db4e3020a853f8b4e32ac5fa49c01af59e4
  • Loading branch information
zhongshengping committed Oct 15, 2018
1 parent ef4ea2e commit fc056e3
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions .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
Expand Down Expand Up @@ -30,11 +42,6 @@ pip-log.txt
# Translations
*.mo

# Mr Developer
.mr.developer.cfg
.project
.pydevproject

# Complexity
output/*.html
output/*/index.html
Expand All @@ -46,10 +53,6 @@ doc/build
AUTHORS
ChangeLog

# Editors
*~
.*.swp

# reno build
releasenotes/build
/doc/source/reference/api/

0 comments on commit fc056e3

Please sign in to comment.