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: I454fd3920103866a39b6322d938e0c90f175489f
ZhongShengping 6 months ago
parent
commit
de4d88d5c1
1 changed files with 12 additions and 9 deletions
  1. 12
    9
      .gitignore

+ 12
- 9
.gitignore View File

@@ -1,3 +1,15 @@
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
+
12
+# Bytecompiled Python
1 13
 *.py[cod]
2 14
 
3 15
 # C extensions
@@ -30,11 +42,6 @@ cover
30 42
 # Translations
31 43
 *.mo
32 44
 
33
-# Mr Developer
34
-.mr.developer.cfg
35
-.project
36
-.pydevproject
37
-
38 45
 # Complexity
39 46
 output/*.html
40 47
 output/*/index.html
@@ -46,9 +53,5 @@ doc/build
46 53
 AUTHORS
47 54
 ChangeLog
48 55
 
49
-# Editors
50
-*~
51
-.*.swp
52
-
53 56
 # reno build
54 57
 releasenotes/build

Loading…
Cancel
Save