Commit 51f1e0a8 authored by Zsolt Dollenstein's avatar Zsolt Dollenstein Committed by Łukasz Langa
Browse files

Create new issue templates (#934)

* Create new issue templates

* style -> design

* Apply suggestions from code review

Co-Authored-By: default avatarHugo van Kemenade <hugovk@users.noreply.github.com>
parent 893dd952
Loading
Loading
Loading
Loading
+29 −8
Changes for .github/ISSUE_TEMPLATE/bug_report.md: 29 added lines, 8 removed lines.
Original line number Diff line number Diff line
Howdy! Sorry you're having trouble. To expedite your experience,
provide some basics for me:
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

Operating system:
Python version:
*Black* version:
Does also happen on master:
---

To answer the last question, you have two options:
**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. 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:
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.

**Additional context**
Add any other context about the problem here.
+20 −0
Changes for .github/ISSUE_TEMPLATE/feature_request.md: 20 added lines, 0 removed lines.
Original line number Diff line number Diff line
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
 No newline at end of file
+30 −0
Changes for .github/ISSUE_TEMPLATE/style_issue.md: 30 added lines, 0 removed lines.
Original line number Diff line number Diff line
---
name: Style issue
about: Help us improve the Black style
title: ''
labels: design
assignees: ''

---

**Describe the style change**
A clear and concise description of how the style can be improved.

**Examples in the current *Black* style**
Think of some short code snippets that show how the current *Black* style is not great:
```
def f():
    "Make sure this code is blackened"""
    pass
```

**Desired style**
How do you think *Black* should format the above snippets:
```
def f(
    ):
    pass
```

**Additional context**
Add any other context about the problem here.