Browse Source

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

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: I8ba491deac8de5d9f2a8ceefba64c0c6a73f92d1
ZhongShengping 6 months ago
parent
commit
baa0a045b5
1 changed files with 11 additions and 4 deletions
  1. 11
    4
      .gitignore

+ 11
- 4
.gitignore View File

@@ -1,5 +1,14 @@
1
-*~
2
-*.swp
1
+# Add patterns in here to exclude files created by tools integrated with this
2
+# repository, such as test frameworks from the project's recommended workflow,
3
+# rendered documentation and package builds.
4
+#
5
+# Don't add patterns to exclude files created by preferred personal tools
6
+# (editors, IDEs, your operating system itself even). These should instead be
7
+# maintained outside the repository, for example in a ~/.gitignore file added
8
+# with:
9
+#
10
+# git config --global core.excludesfile '~/.gitignore'
11
+
3 12
 *.pyc
4 13
 *.log
5 14
 .coverage
@@ -15,7 +24,5 @@ AUTHORS
15 24
 ChangeLog
16 25
 *.egg
17 26
 .stestr/
18
-.project
19
-.pydevproject
20 27
 oslo.db.egg-info/
21 28
 doc/source/reference/api

Loading…
Cancel
Save