summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnthony Sottile <asottile@umich.edu>2021-04-04 09:28:57 -0700
committerGitHub <noreply@github.com>2021-04-04 09:28:57 -0700
commit1623a8ea4f6665f95978bfc3ff386480f2aa1158 (patch)
treececa2d19c8565fca3ef3cd0c1c5b8200ee25f9ad
parent97134d5a32e6d02413043a45618068146ad1612b (diff)
parent28510409b5c531a916cc950215e30e6d24468133 (diff)
downloadflake8-1623a8ea4f6665f95978bfc3ff386480f2aa1158.tar.gz
Merge pull request #1306 from PyCQA/issue_template
add issue template
-rw-r--r--.github/ISSUE_TEMPLATE.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..365305d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,33 @@
+Please read this brief portion of documentation before going any further: http://flake8.pycqa.org/en/latest/internal/contributing.html#filing-a-bug
+
+<!--
+*************************************************************************
+NOTE: flake8 is a linting framework and does not implement any checks
+
+if you are reporting a problem with a particular check, please track down
+the plugin which implements that check.
+
+some common ones:
+- F###: https://github.com/pycqa/pyflakes
+- E###, W###: https://github.com/pycqa/pycodestyle
+*************************************************************************
+-->
+
+
+*Please describe how you installed Flake8*
+
+Example:
+
+```
+$ pip install --user flake8
+$ brew install flake8
+# etc.
+```
+
+**Note**: Some *nix distributions patch Flake8 arbitrarily to accommodate incompatible software versions. If you're on one of those distributions, your issue may be closed and you will be asked to open an issue with your distribution package maintainers instead.
+
+*Please provide the exact, unmodified output of `flake8 --bug-report`*
+
+*Please describe the problem or feature*
+
+*If this is a bug report, please explain with examples (and example code) what you expected to happen and what actually happened.*