Skip to content

Commit 3e8a716

Browse files
authored
Merge pull request #67 from numpy/dx/add-github-templates
DOC: Add GitHub issue templates
2 parents f681ec3 + ea02290 commit 3e8a716

File tree

4 files changed

+115
-0
lines changed

4 files changed

+115
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Bug report
2+
description: Report a bug. For security vulnerabilities see Report a security vulnerability in the templates.
3+
title: "BUG: <Please write a comprehensive title after the 'BUG: ' prefix>"
4+
labels: [00 - Bug]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
Thank you for taking the time to file a bug report. Before creating a new
11+
issue, please make sure to take a few minutes to check the issue tracker
12+
for existing issues about the bug.
13+
14+
- type: textarea
15+
attributes:
16+
label: "Describe the issue:"
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
attributes:
22+
label: "Reproduce the code example:"
23+
description: >
24+
A short code example that reproduces the problem/missing feature. It
25+
should be self-contained, i.e., can be copy-pasted into the Python
26+
interpreter or run as-is via `python myproblem.py`.
27+
placeholder: |
28+
import numpy_financial as npf
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 full error message, if any.
39+
If you are reporting a segfault please include a GDB traceback,
40+
which you can generate by following
41+
[these instructions](https://github.com/numpy/numpy/blob/main/doc/source/dev/development_environment.rst#debugging).
42+
placeholder: |
43+
<< Full traceback starting from `Traceback: ...` >>
44+
render: shell
45+
46+
- type: textarea
47+
attributes:
48+
label: "Runtime information:"
49+
description: >
50+
Output from `import sys, numpy; print(numpy.__version__); print(sys.version)`
51+
If you are running NumPy 1.24+, also show `print(numpy.show_runtime())`
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
attributes:
57+
label: "Context for the issue:"
58+
description: |
59+
Please explain how this issue affects your work or why it should be prioritized.
60+
placeholder: |
61+
<< your explanation here >>
62+
validations:
63+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
contact_links:
2+
- name: Question/Help/Support
3+
url: https://numpy.org/gethelp/
4+
about: "If you have a question, please look at the listed resources available on the website."
5+
- name: Development-related matters
6+
url: https://numpy.org/community/
7+
about: "If you would like to discuss development-related matters or need help from the NumPy team, see our community's communication channels."
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Documentation
2+
description: Report an issue related to the NumPy-Financial documentation.
3+
title: "DOC: <Please write a comprehensive title after the 'DOC: ' prefix>"
4+
labels: [04 - Documentation]
5+
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: "Issue with current documentation:"
10+
description: >
11+
Please make sure to leave a reference to the document/code you're
12+
referring to. You can also check the development version of the
13+
documentation and see if this issue has already been addressed at
14+
https://numpy.org/devdocs.
15+
16+
- type: textarea
17+
attributes:
18+
label: "Idea or request for content:"
19+
description: >
20+
Please describe as clearly as possible what topics you think are missing
21+
from the current documentation. Make sure to check
22+
https://github.com/numpy/numpy-tutorials and see if this issue might be
23+
more appropriate there.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Feature request
2+
description: Check instructions for submitting your idea on the mailing list first.
3+
title: "ENH: <Please write a comprehensive title after the 'ENH: ' prefix>"
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
If you're looking to request a new feature or change in functionality,
10+
including adding or changing the meaning of arguments to an existing
11+
function, please post your idea on the
12+
[numpy-discussion mailing list](https://mail.python.org/mailman/listinfo/numpy-discussion)
13+
to explain your reasoning in addition to opening an issue or pull request.
14+
You can also check out our
15+
[Contributor Guide](https://github.com/numpy/numpy/blob/main/doc/source/dev/index.rst)
16+
if you need more information.
17+
18+
- type: textarea
19+
attributes:
20+
label: "Proposed new feature or change:"
21+
validations:
22+
required: true

0 commit comments

Comments
 (0)