madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Do not wrap implicitly concatenated strings used as func args in parens (#3640)
[etc/vim.git] / .github / ISSUE_TEMPLATE / bug_report.md
index c6c80be5345b8fa1ba4acb6ee84f6c07ba48a222..48aa9291b0523359cd34eb3924bd7a724aae4e58 100644 (file)
@@ -1,36 +1,64 @@
 ---
 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.
+<!--
+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:
 
-**To Reproduce** Steps to reproduce the behavior:
+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.
+-->
 
-1. Take this file '...'
-1. Run _Black_ on it with these arguments '....'
-1. See error
+**Describe the bug**
 
-**Expected behavior** A clear and concise description of what you expected to happen.
+<!-- A clear and concise description of what the bug is. -->
 
-**Environment (please complete the following information):**
+**To Reproduce**
 
-- Version: \[e.g. main\]
-- OS and Python version: \[e.g. Linux/Python 3.7.4rc1\]
+<!--
+Minimal steps to reproduce the behavior with source code and Black's configuration.
+-->
 
-**Does this bug also happen on main?** To answer this, you have two options:
+For example, take this code:
 
-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.
+```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**
+
+<!-- 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. -->