summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorRodolfo Carvalho <rhcarvalho@gmail.com>2017-02-19 11:52:07 +0100
committerGitHub <noreply@github.com>2017-02-19 11:52:07 +0100
commite7cbe87fd35963666f8007b36a5168ffd84f6107 (patch)
tree8c87c0b275b0eb8555543f985599c1547c5502bc /CONTRIBUTING.md
parent62ef1580fdb5346283c70953338b91fdddce2936 (diff)
parent5e04d306d6d543d7b040f9ccd313be176f5b211b (diff)
downloadopenshift-e7cbe87fd35963666f8007b36a5168ffd84f6107.tar.gz
openshift-e7cbe87fd35963666f8007b36a5168ffd84f6107.tar.bz2
openshift-e7cbe87fd35963666f8007b36a5168ffd84f6107.tar.xz
openshift-e7cbe87fd35963666f8007b36a5168ffd84f6107.zip
Merge pull request #3412 from rhcarvalho/dead-code
Remove and document how to find dead Python code
Diffstat (limited to 'CONTRIBUTING.md')
-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.