summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRodolfo Carvalho <rhcarvalho@gmail.com>2017-02-18 15:24:35 +0100
committerRodolfo Carvalho <rhcarvalho@gmail.com>2017-02-18 15:24:35 +0100
commitbafc254e3204f4ae5f9cd0ef30ef23dbb57cd4d1 (patch)
tree03bc33062c208c9428c78fb5e84746096c95a82d
parent701bd042f01df17d3363c8c31755eafabcf21fa7 (diff)
downloadopenshift-bafc254e3204f4ae5f9cd0ef30ef23dbb57cd4d1.tar.gz
openshift-bafc254e3204f4ae5f9cd0ef30ef23dbb57cd4d1.tar.bz2
openshift-bafc254e3204f4ae5f9cd0ef30ef23dbb57cd4d1.tar.xz
openshift-bafc254e3204f4ae5f9cd0ef30ef23dbb57cd4d1.zip
Document how to find dead Python code
-rw-r--r--CONTRIBUTING.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index dafa73bad..502ef6aa5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -152,3 +152,17 @@ are run on a different Jenkins host that is not publicly accessible, however the
test results are posted to S3 buckets when complete.
The test output of each job is also posted to the Pull Request as comments.
+
+---
+
+## Appendix
+
+### Finding unused Python code
+
+If you are contributing with Python code, you can use the tool
+[`vulture`](https://pypi.python.org/pypi/vulture) to verify that you are not
+introducing unused code by accident.
+
+This tool is not used in an automated form in CI nor otherwise because it may
+produce both false positives and false negatives. Still, it can be helpful to
+detect dead code that escapes our eyes.