Skip to content

Commit

Permalink
Make the new bug templates less markup-heavy (python#9438)
Browse files Browse the repository at this point in the history
- Remove emoji
- Instead of `## H2 headings` just use `**bold**`
- Add link to docs
- Add suggestion for new users not to file a bug
  • Loading branch information
gvanrossum authored Sep 11, 2020
1 parent f743b0a commit 6f07cb6
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 18 deletions.
23 changes: 14 additions & 9 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,32 @@
---
name: 🐛 Bug Report
name: Bug Report
about: Submit a bug report
labels: "bug"
---

<!--
If you're new to mypy and you're not sure whether what you're experiencing is a mypy bug, please see the "Question and Help" form
instead.
-->

**Bug Report**

<!--
Note: If the problem you are reporting is about a specific library function, then the typeshed tracker is better suited
for this report: https://github.com/python/typeshed/issues
-->

## 🐛 Bug Report

(A clear and concise description of what the bug is.)

## To Reproduce
**To Reproduce**

(Write your steps here:)

1. Step 1...
1. Step 2...
1. Step 3...
2. Step 2...
3. Step 3...

## Expected Behavior
**Expected Behavior**

<!--
How did you expect your project to behave?
Expand All @@ -31,7 +36,7 @@ for this report: https://github.com/python/typeshed/issues

(Write what you thought would happen.)

## Actual Behavior
**Actual Behavior**

<!--
Did something go wrong?
Expand All @@ -40,7 +45,7 @@ for this report: https://github.com/python/typeshed/issues

(Write what happened.)

## Your Environment
**Your Environment**

<!-- Include as many relevant details about the environment you experienced the bug in -->

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: 📚 Documentation
name: Documentation
about: Report a problem with the documentation
labels: "documentation"
---

## 📚 Documentation
**Documentation**

(A clear and concise description of the issue.)
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
name: 🚀 Feature
name: Feature
about: Submit a proposal for a new mypy feature
labels: "feature"
---

## 🚀 Feature
**Feature**

(A clear and concise description of your feature proposal.)

## Pitch
**Pitch**

(Please explain why this feature should be implemented and how it would be used. Add examples, if applicable.)
9 changes: 5 additions & 4 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
---
name: Questions and Help
name: Questions and Help
about: If you have questions, please check the below links
labels: "question"
---

## Questions and Help
**Questions and Help**

### Please note that this issue tracker is not a help form and this issue will be closed.
_Please note that this issue tracker is not a help form and this issue will be closed._

Please contact us instead.
Please check here instead:

- [Website](http://www.mypy-lang.org/)
- [Documentation](https://mypy.readthedocs.io/)
- [Gitter](https://gitter.im/python/typing)

0 comments on commit 6f07cb6

Please sign in to comment.