black/.github/ISSUE_TEMPLATE/bug_report.md
Richard Si 3ef339b2e7
Modify when Test, Primer, and Documentation Build run (#2226)
- Test and Primer don't run for documentation only changes since it's
  unnecessary, eating unnecessary cycles and slowing down CI since these
  workflows eat up the 20 max workers limit quite easily!

- Documentation Build runs all of the time now since quite a bit of the
  content depends on Black's code so even a simple 1-file change in
  src/black/__init__.py may break the docs build. It's not like this is
  a costly workflow anyway.

Fuzz is still running on all changes because with fuzzing, the more the
better in general. 6 or 7 jobs on a documentation only commit is much
better than 27/28 jobs anyway :p

I also found an error in our bug report issue template :)
2021-05-12 21:28:41 -04:00

1.1 KiB

name about title labels assignees
Bug report Create a report to help us improve bug

Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

  1. Take this file '...'
  2. Run Black on it with these arguments '....'
  3. 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.
  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 .[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.

Additional context Add any other context about the problem here.