Skip to content

Updated issue templates and added pull request templates #9367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 27, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
name: 🐛 Bug Report
about: Submit a bug report
labels: "bug"
---

<!--
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

(Write your steps here:)

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

## Expected Behavior

<!--
How did you expect your project to behave?
It’s fine if you’re not sure your understanding is correct.
Write down what you thought would happen. If you just expected no errors, you can delete this section.
-->

(Write what you thought would happen.)

## Actual Behavior

<!--
Did something go wrong?
Is something broken, or not behaving as you expected?
-->

(Write what happened.)

## Your Environment

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

- Mypy version used:
- Mypy command-line flags:
- Mypy configuration options from `mypy.ini` (and other config files):
- Python version used:
- Operating system and version:

<!--
You can freely edit this text, please remove all the lines
you believe are unnecessary.
-->
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: 📚 Documentation
about: Report a problem with the documentation
labels: "documentation"
---

## 📚 Documentation

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

## 🚀 Feature

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

## Pitch

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

## ❓ Questions and Help

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

Please contact us instead.

- [Website](http://www.mypy-lang.org/)
- [Gitter](https://gitter.im/python/typing)
22 changes: 22 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
### Have you read the [Contributing Guidelines](https://github.com/python/mypy/blob/master/CONTRIBUTING.md)?

(Once you have, delete this section. If you leave it in, your PR may be closed without action.)

### Description

<!--
If this pull request closes or fixes an issue, write Closes #NNN" or "Fixes #NNN" in that exact
format.
-->

(Explain how this PR changes mypy.)

## Test Plan

<!--
If this is a documentation change, rebuild the docs (link to instructions) and review the changed pages for markup errors.
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).
If this change cannot be tested by the CI, please explain how to verify it manually.
-->

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)
20 changes: 0 additions & 20 deletions ISSUE_TEMPLATE.md

This file was deleted.