summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2021-02-22 19:37:13 +0100
committerPierre Sassoulas <pierre.sassoulas@gmail.com>2021-02-23 20:46:19 +0100
commit8cbcf87e80cf7886a05c760a92e11ee27e913d75 (patch)
tree36d1f947a14c951b3226577c5e92d0d4a1ec2986
parent8f39e8fb07baf4df1d3638dae6419aee21594631 (diff)
downloadpylint-git-8cbcf87e80cf7886a05c760a92e11ee27e913d75.tar.gz
Guide the user more in the bug report
Would probably permit to have the version more often and to have something to do a functional test with more often too.
-rw-r--r--.github/ISSUE_TEMPLATE/1_Bug_report.md45
-rw-r--r--.github/ISSUE_TEMPLATE/2_Feature_request.md1
2 files changed, 40 insertions, 6 deletions
diff --git a/.github/ISSUE_TEMPLATE/1_Bug_report.md b/.github/ISSUE_TEMPLATE/1_Bug_report.md
index feaaeeb9a..b4c2e1ddc 100644
--- a/.github/ISSUE_TEMPLATE/1_Bug_report.md
+++ b/.github/ISSUE_TEMPLATE/1_Bug_report.md
@@ -10,19 +10,54 @@ about: Report a bug in pylint
Before you submit this, make sure that the issue doesn't already exist
or if it is not closed.
- Is your issue fixed on the preview release?: pip install pylint astroid --pre -U
-
+ Is your issue fixed on the preview release?:
+ pip install pylint astroid --pre -U
-->
### Steps to reproduce
-1.
-2.
-3.
+
+<!--
+Given a file `a.py`:
+```python
+# (Disable message unrelated to the bug)
+# pylint: disable=missing-docstring,...
+
+```
+
+Given multiple files:
+```
+__init__.py
+a.py
+module\
+ __init__.py
+ b.py
+ c.py
+```
+-->
### Current behavior
+<!--
+Result of `pylint a.py`:
+```
+```
+-->
### Expected behavior
### pylint --version output
+
+Result of `pylint --version` output:
+```
+
+```
+
+<!--
+Additional dependencies:
+```
+pandas==0.23.2
+marshmallow==3.10.0
+...
+```
+-->
diff --git a/.github/ISSUE_TEMPLATE/2_Feature_request.md b/.github/ISSUE_TEMPLATE/2_Feature_request.md
index 685143415..b9dca130d 100644
--- a/.github/ISSUE_TEMPLATE/2_Feature_request.md
+++ b/.github/ISSUE_TEMPLATE/2_Feature_request.md
@@ -17,6 +17,5 @@ A clear and concise description of what the problem is.
### Describe the solution you'd like
A clear and concise description of what you want to happen.
-
### Additional context
Add any other context about the feature request here.