Skip to content

DOC: Add GitHub issue templates #67

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
Nov 11, 2023
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
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Bug report
description: Report a bug. For security vulnerabilities see Report a security vulnerability in the templates.
title: "BUG: <Please write a comprehensive title after the 'BUG: ' prefix>"
labels: [00 - Bug]

body:
- type: markdown
attributes:
value: >
Thank you for taking the time to file a bug report. Before creating a new
issue, please make sure to take a few minutes to check the issue tracker
for existing issues about the bug.

- type: textarea
attributes:
label: "Describe the issue:"
validations:
required: true

- type: textarea
attributes:
label: "Reproduce the code example:"
description: >
A short code example that reproduces the problem/missing feature. It
should be self-contained, i.e., can be copy-pasted into the Python
interpreter or run as-is via `python myproblem.py`.
placeholder: |
import numpy_financial as npf
<< your code here >>
render: python
validations:
required: true

- type: textarea
attributes:
label: "Error message:"
description: >
Please include full error message, if any.
If you are reporting a segfault please include a GDB traceback,
which you can generate by following
[these instructions](https://github.com/numpy/numpy/blob/main/doc/source/dev/development_environment.rst#debugging).
placeholder: |
<< Full traceback starting from `Traceback: ...` >>
render: shell

- type: textarea
attributes:
label: "Runtime information:"
description: >
Output from `import sys, numpy; print(numpy.__version__); print(sys.version)`
If you are running NumPy 1.24+, also show `print(numpy.show_runtime())`
validations:
required: true

- type: textarea
attributes:
label: "Context for the issue:"
description: |
Please explain how this issue affects your work or why it should be prioritized.
placeholder: |
<< your explanation here >>
validations:
required: false
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
contact_links:
- name: Question/Help/Support
url: https://numpy.org/gethelp/
about: "If you have a question, please look at the listed resources available on the website."
- name: Development-related matters
url: https://numpy.org/community/
about: "If you would like to discuss development-related matters or need help from the NumPy team, see our community's communication channels."
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Documentation
description: Report an issue related to the NumPy-Financial documentation.
title: "DOC: <Please write a comprehensive title after the 'DOC: ' prefix>"
labels: [04 - Documentation]

body:
- type: textarea
attributes:
label: "Issue with current documentation:"
description: >
Please make sure to leave a reference to the document/code you're
referring to. You can also check the development version of the
documentation and see if this issue has already been addressed at
https://numpy.org/devdocs.

- type: textarea
attributes:
label: "Idea or request for content:"
description: >
Please describe as clearly as possible what topics you think are missing
from the current documentation. Make sure to check
https://github.com/numpy/numpy-tutorials and see if this issue might be
more appropriate there.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Feature request
description: Check instructions for submitting your idea on the mailing list first.
title: "ENH: <Please write a comprehensive title after the 'ENH: ' prefix>"

body:
- type: markdown
attributes:
value: >
If you're looking to request a new feature or change in functionality,
including adding or changing the meaning of arguments to an existing
function, please post your idea on the
[numpy-discussion mailing list](https://mail.python.org/mailman/listinfo/numpy-discussion)
to explain your reasoning in addition to opening an issue or pull request.
You can also check out our
[Contributor Guide](https://github.com/numpy/numpy/blob/main/doc/source/dev/index.rst)
if you need more information.

- type: textarea
attributes:
label: "Proposed new feature or change:"
validations:
required: true