Skip to content

Commit 5c57c5b

Browse files
authored
New issue templates and PR template (#9367)
1 parent 42a5220 commit 5c57c5b

File tree

6 files changed

+114
-20
lines changed

6 files changed

+114
-20
lines changed

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Submit a bug report
4+
labels: "bug"
5+
---
6+
7+
<!--
8+
Note: If the problem you are reporting is about a specific library function, then the typeshed tracker is better suited
9+
for this report: https://github.com/python/typeshed/issues
10+
-->
11+
12+
## 🐛 Bug Report
13+
14+
(A clear and concise description of what the bug is.)
15+
16+
## To Reproduce
17+
18+
(Write your steps here:)
19+
20+
1. Step 1...
21+
1. Step 2...
22+
1. Step 3...
23+
24+
## Expected Behavior
25+
26+
<!--
27+
How did you expect your project to behave?
28+
It’s fine if you’re not sure your understanding is correct.
29+
Write down what you thought would happen. If you just expected no errors, you can delete this section.
30+
-->
31+
32+
(Write what you thought would happen.)
33+
34+
## Actual Behavior
35+
36+
<!--
37+
Did something go wrong?
38+
Is something broken, or not behaving as you expected?
39+
-->
40+
41+
(Write what happened.)
42+
43+
## Your Environment
44+
45+
<!-- Include as many relevant details about the environment you experienced the bug in -->
46+
47+
- Mypy version used:
48+
- Mypy command-line flags:
49+
- Mypy configuration options from `mypy.ini` (and other config files):
50+
- Python version used:
51+
- Operating system and version:
52+
53+
<!--
54+
You can freely edit this text, please remove all the lines
55+
you believe are unnecessary.
56+
-->
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: 📚 Documentation
3+
about: Report a problem with the documentation
4+
labels: "documentation"
5+
---
6+
7+
## 📚 Documentation
8+
9+
(A clear and concise description of the issue.)

.github/ISSUE_TEMPLATE/feature.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: 🚀 Feature
3+
about: Submit a proposal for a new mypy feature
4+
labels: "feature"
5+
---
6+
7+
## 🚀 Feature
8+
9+
(A clear and concise description of your feature proposal.)
10+
11+
## Pitch
12+
13+
(Please explain why this feature should be implemented and how it would be used. Add examples, if applicable.)

.github/ISSUE_TEMPLATE/question.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: ❓ Questions and Help
3+
about: If you have questions, please check the below links
4+
labels: "question"
5+
---
6+
7+
## ❓ Questions and Help
8+
9+
### Please note that this issue tracker is not a help form and this issue will be closed.
10+
11+
Please contact us instead.
12+
13+
- [Website](http://www.mypy-lang.org/)
14+
- [Gitter](https://gitter.im/python/typing)

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
### Have you read the [Contributing Guidelines](https://github.com/python/mypy/blob/master/CONTRIBUTING.md)?
2+
3+
(Once you have, delete this section. If you leave it in, your PR may be closed without action.)
4+
5+
### Description
6+
7+
<!--
8+
If this pull request closes or fixes an issue, write Closes #NNN" or "Fixes #NNN" in that exact
9+
format.
10+
-->
11+
12+
(Explain how this PR changes mypy.)
13+
14+
## Test Plan
15+
16+
<!--
17+
If this is a documentation change, rebuild the docs (link to instructions) and review the changed pages for markup errors.
18+
If this is a code change, include new tests (link to the testing docs). Be sure to run the tests locally and fix any errors before submitting the PR (more instructions).
19+
If this change cannot be tested by the CI, please explain how to verify it manually.
20+
-->
21+
22+
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

ISSUE_TEMPLATE.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)