Print out line diff on test failure (#2552)

[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 f4a438622aaef274309e4ec2d13c9eed597c5d13..e8d232c8b34c840846090534b551a073f5fb9923 100644 (file)
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,36 +1,47 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Create a report to help us improve Black's quality
 title: ""
-labels: bug
+labels: "T: bug"
 assignees: ""
 ---
 
-**Describe the bug** A clear and concise description of what the bug is.
+**Describe the bug**
 
-**To Reproduce** Steps to reproduce the behavior:
+<!-- A clear and concise description of what the bug is. -->
 
+**To Reproduce**
+
+<!-- Steps to reproduce the behavior:
+
+For example:
 1. Take this file '...'
-2. Run _Black_ on it with these arguments '....'
-3. See error
+1. Run _Black_ on it with these arguments '...'
+1. See error -->
+
+**Expected behavior**
 
-**Expected behavior** A clear and concise description of what you expected to happen.
+<!-- 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]
+- Version: <!-- e.g. [main] -->
+- 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:
+**Does this bug also happen on main?**
 
-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:
+<!-- To answer this, you have two options:
+
+1. Use the online formatter at <https://black.vercel.app/?version=main>, which will use
+   the latest main branch.
+1. 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,python2]`;
    - run `pip install -r test_requirements.txt`
-   - make sure it's sane by running `python -m unittest`; and
-   - run `black` like you did last time.
+   - make sure it's sane by running `python -m pytest`; and
+   - run `black` like you did last time. -->
+
+**Additional context**
 
-**Additional context** Add any other context about the problem here.
+<!-- Add any other context about the problem here. -->