Create an issue template for the project

This patch adds a template for Issues opened against the Bandit project. That way, minimum information is present to debug the problem. This change also adds more output to --version to display the python version information like so: bandit 1.4.1 python version = 2.7.12 (default, Dec 4 2017, 14:50:18) [GCC 5.4.0 20160609] Signed-off-by: Eric Brown <[email protected]>
PyCQA · May 5, 2018 · 094a2d4 · 094a2d4
1 parent 451005a
commit 094a2d4
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/.github/issue_template.md b/.github/issue_template.md
@@ -0,0 +1,15 @@
+### Summary 
+
+### Steps to reproduce the behavior
+
+### Bandit version
+<!--- Paste the output from "bandit --version" between quotes below -->
+```
+
+```
+
+### Operating system / Environment
+
+### Expected behavior
+
+### Actual behavior
diff --git a/bandit/cli/main.py b/bandit/cli/main.py
@@ -245,10 +245,13 @@ def main():
         '--ini', dest='ini_path', action='store', default=None,
         help='path to a .bandit file that supplies command line arguments'
     )
+    python_ver = sys.version.replace('\n', '')
     parser.add_argument(
         '--version', action='version',
-        version='%(prog)s {version}'.format(version=bandit.__version__)
+        version='%(prog)s {version}\n  python version = {python}'.format(
+            version=bandit.__version__, python=python_ver)
     )
+
     parser.set_defaults(debug=False)
     parser.set_defaults(verbose=False)
     parser.set_defaults(ignore_nosec=False)