Skip to content

Commit 06a0fdf

Browse files
committed
DOC: Issue template for static typing
1 parent be20220 commit 06a0fdf

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

.github/ISSUE_TEMPLATE/typing.yml

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Static Typing
2+
description: Report an issue with the NumPy typing hints.
3+
title: "TYP: <Please write a comprehensive title after the 'TYP: ' prefix>"
4+
labels: [Static typing]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
Thank you for taking the time to report this issue.
11+
Please make sure that this issue hasn't already been reported before.
12+
13+
- type: textarea
14+
attributes:
15+
label: "Describe the issue:"
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
attributes:
21+
label: "Reproduce the code example:"
22+
description: >
23+
A short code example that reproduces the error in your type-checker. It
24+
should be self-contained, i.e., can be run as-is via e.g.
25+
`mypy myproblem.py` or `pyright myproblem.py`.
26+
placeholder: |
27+
import numpy as np
28+
import numpy.typing as npt
29+
<< your code here >>
30+
render: python
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
attributes:
36+
label: "Error message:"
37+
description: >
38+
Please include all relevant error messages from your type-checker or IDE.
39+
render: shell
40+
41+
- type: textarea
42+
attributes:
43+
label: "Python and NumPy Versions:"
44+
description: >
45+
Output from `import sys, numpy; print(numpy.__version__); print(sys.version)`.
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
attributes:
51+
label: "Type-checker version and settings:"
52+
description: >
53+
Please include the exact version of the type-checker you are using.
54+
Popular (static) type checkers include Mypy, Pyright / Pylance, Pytype,
55+
Pyre, PyCharm, etc.
56+
Also include the full CLI command used to run the type-checker, and
57+
all of the relevant configuration options.
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
attributes:
63+
label: "Additional typing packages."
64+
description: |
65+
If you are using `typing-extensions` or typing-stub packages, please
66+
list their versions here.
67+
validations:
68+
required: false

0 commit comments

Comments
 (0)