]> git.madduck.net Git - etc/vim.git/blobdiff - .github/ISSUE_TEMPLATE/bug_report.md

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:

Bump myst-parser from 0.16.0 to 0.16.1 in /docs (#2710)
[etc/vim.git] / .github / ISSUE_TEMPLATE / bug_report.md
index 4c51d3020bbbbca39a300e8d1cd7df534b45cb77..cb64cf9325d56d2da3e3335b9d15429482967962 100644 (file)
@@ -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,python2]`;
+   - 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. -->