]> git.madduck.net Git - etc/vim.git/blob - .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:

Issue templates: use HTML comments (#2269)
[etc/vim.git] / .github / ISSUE_TEMPLATE / bug_report.md
1 ---
2 name: Bug report
3 about: Create a report to help us improve
4 title: ""
5 labels: bug
6 assignees: ""
7 ---
8
9 **Describe the bug**
10
11 <!-- A clear and concise description of what the bug is. -->
12
13 **To Reproduce**
14
15 <!-- Steps to reproduce the behavior:
16
17 For example:
18 1. Take this file '...'
19 1. Run _Black_ on it with these arguments '...'
20 1. See error -->
21
22 **Expected behavior**
23
24 <!-- A clear and concise description of what you expected to happen. -->
25
26 **Environment (please complete the following information):**
27
28 - Version: <!-- e.g. [main] -->
29 - OS and Python version: <!-- e.g. [Linux/Python 3.7.4rc1] -->
30
31 **Does this bug also happen on main?**
32
33 <!-- To answer this, you have two options:
34
35 1. Use the online formatter at <https://black.vercel.app/?version=main>, which will use
36    the latest main branch.
37 1. Or run _Black_ on your machine:
38    - create a new virtualenv (make sure it's the same Python version);
39    - clone this repository;
40    - run `pip install -e .[d,python2]`;
41    - run `pip install -r test_requirements.txt`
42    - make sure it's sane by running `python -m pytest`; and
43    - run `black` like you did last time. -->
44
45 **Additional context**
46
47 <!-- Add any other context about the problem here. -->