black/.github/ISSUE_TEMPLATE/bug_report.md
Panagiotis Vasilopoulos 06ccb88bf2
Replace references to master branch (#2210)
Commit history before merge:

* Replace references to master branch
* Update .flake8 to reference docs on RTD

  We're moving away from GitHub as a documentation host to only RTD because
  it's makes our lives easier creating good docs. I know this link is dead right now,
  but it won't be once we release a new version with the documentation reorganization
  changes (which should be soon!).

  Co-authored-by: Richard Si <63936253+ichard26@users.noreply.github.com>
2021-05-09 17:50:17 -04:00

37 lines
1.1 KiB
Markdown

---
name: Bug report
about: Create a report to help us improve
title: ""
labels: bug
assignees: ""
---
**Describe the bug** A clear and concise description of what the bug is.
**To Reproduce** Steps to reproduce the behavior:
1. Take this file '...'
1. Run _Black_ on it with these arguments '....'
1. See error
**Expected behavior** A clear and concise description of what you expected to happen.
**Environment (please complete the following information):**
- Version: \[e.g. main\]
- OS and Python version: \[e.g. Linux/Python 3.7.4rc1\]
**Does this bug also happen on main?** 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.
**Additional context** Add any other context about the problem here.