Update docs to include pycodestyle (#3369)

[etc/vim.git] / .github / ISSUE_TEMPLATE / bug_report.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 4c51d3020bbbbca39a300e8d1cd7df534b45cb77..48aa9291b0523359cd34eb3924bd7a724aae4e58 100644 (file)
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,37 +1,64 @@
 ---
 name: Bug report
 ---
 name: Bug report

-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: ''
-
+about: Create a report to help us improve Black's quality
+title: ""
+labels: "T: bug"
+assignees: ""

 ---
 
 ---
 

+<!--
+Please make sure that the bug is not already fixed either in newer versions or the
+current development version. To confirm this, you have three options:
+
+1. Update Black's version if a newer release exists: `pip install -U black`
+2. Use the online formatter at <https://black.vercel.app/?version=main>, which will use
+   the latest main branch.
+3. Or run _Black_ on your machine:
+   - create a new virtualenv (make sure it's the same Python version);
+   - clone this repository;
+   - run `pip install -e .[d]`;
+   - run `pip install -r test_requirements.txt`
+   - make sure it's sane by running `python -m pytest`; and
+   - run `black` like you did last time.
+-->
+

 **Describe the bug**
 **Describe the bug**

-A clear and concise description of what the bug is.
+
+<!-- A clear and concise description of what the bug is. -->

 
 **To Reproduce**
 
 **To Reproduce**

-Steps to reproduce the behavior:
-1. Take this file '...'
-2. Run *Black* on it with these arguments '....'
-3. See error
+
+<!--
+Minimal steps to reproduce the behavior with source code and Black's configuration.
+-->
+
+For example, take this code:
+
+```python
+this = "code"
+```
+
+And run it with these arguments:
+
+```sh
+$ black file.py --target-version py39
+```
+
+The resulting error is:
+
+> cannot format file.py: INTERNAL ERROR: ...

 
 **Expected behavior**
 
 **Expected behavior**

-A clear and concise description of what you expected to happen.
-
-**Environment (please complete the following information):**
-- Version: [e.g. master]
-- OS and Python version: [e.g. Linux/Python 3.7.4rc1]
-
-**Does this bug also happen on master?**
-To answer this, you have two options:
-1. Use the online formatter at https://black.now.sh/?version=master, which will use the latest master branch.
-2. Or run *Black* on your machine:
-    * create a new virtualenv (make sure it's the same Python version);
-    * clone this repository;
-    * run `pip install -e .`;
-    * make sure it's sane by running `python setup.py test`; and
-    * run `black` like you did last time.
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+**Environment**
+
+<!-- Please complete the following information: -->
+
+- Black's version: <!-- e.g. [main] -->
+- OS and Python version: <!-- e.g. [Linux/Python 3.7.4rc1] -->

 
 **Additional context**
 
 **Additional context**

-Add any other context about the problem here.
+
+<!-- Add any other context about the problem here. -->