diff options
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug-report.md | 30 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug-report.yml | 49 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/documentation.md | 20 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/documentation.yml | 23 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature-request.md | 16 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature-request.yml | 22 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/post-install.md | 21 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/post-install.yml | 28 |
8 files changed, 122 insertions, 87 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 6da1f7370..000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: "Bug report" -about: Report a bug. Not for security vulnerabilities -- see below. - ---- - -<!-- Please describe the issue in detail here, and fill in the fields below --> - -### Reproducing code example: - -<!-- A short code example that reproduces the problem/missing feature. It should be -self-contained, i.e., possible to run as-is via 'python myproblem.py' --> - -```python -import numpy as np -<< your code here >> -``` - -### Error message: - -<!-- If you are reporting a segfault please include a GDB traceback, which you -can generate by following -https://github.com/numpy/numpy/blob/main/doc/source/dev/development_environment.rst#debugging --> - -<!-- Full error message, if any (starting from line Traceback: ...) --> - -### NumPy/Python version information: - -<!-- Output from 'import sys, numpy; print(numpy.__version__, sys.version)' --> - diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..b46225968 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,49 @@ +name: Bug report +description: Report a bug. For security vulnerabilities see Report a security vulnerability in the templates. +title: "BUG: " +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 as np + << your code here >> + render: python + validations: + required: true + +- type: textarea + attributes: + label: "Error message:" + description: > + Please include full error message, if any (starting from `Traceback: ...`). + 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). + render: shell + +- type: textarea + attributes: + label: "NumPy/Python version information:" + description: Output from `import sys, numpy; print(numpy.__version__, sys.version)`. + validations: + required: true
\ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index cdb7cde2e..000000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: "Documentation" -about: Report an issue related to the NumPy documentation -labels: 04 - Documentation - ---- - -## Documentation - -<!-- If this is an issue with the current documentation for NumPy (e.g. -incomplete/inaccurate docstring, unclear explanation in any part of the -documentation), 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: https://numpy.org/devdocs/ ---> - -<!-- If this is an idea or a request for content, 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. --> diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 000000000..1005d3ade --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,23 @@ +name: Documentation +description: Report an issue related to the NumPy documentation. +title: "DOC: " +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.
\ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 68872ec06..000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: "Feature request" -about: Check instructions for submitting your idea on the mailing list first. - ---- - -## Feature - -<!-- 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. --> diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..5e2af4015 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,22 @@ +name: Feature request +description: Check instructions for submitting your idea on the mailing list first. +title: "ENH: " + +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
\ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/post-install.md b/.github/ISSUE_TEMPLATE/post-install.md deleted file mode 100644 index 11b91384c..000000000 --- a/.github/ISSUE_TEMPLATE/post-install.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: "Post-install/importing issue" -about: If you have trouble importing or using NumPy after installation -labels: 32 - Installation - ---- - -<!-- Please describe the issue in detail here, and fill in the fields below. Also, check our Troubleshooting ImportError document to see if your issue is listed there: https://numpy.org/devdocs/user/troubleshooting-importerror.html --> - -### Steps to reproduce: - -<!-- Please describe the installation method (e.g. building from source, Anaconda, pip), your OS and NumPy/Python version information --> - -### Error message: - -<!-- If you are reporting a segfault please include a GDB traceback, which you -can generate by following -https://github.com/numpy/numpy/blob/main/doc/source/dev/development_environment.rst#debugging --> - -<!-- Full error message, if any (starting from line Traceback: ...) --> - diff --git a/.github/ISSUE_TEMPLATE/post-install.yml b/.github/ISSUE_TEMPLATE/post-install.yml new file mode 100644 index 000000000..5831994d1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/post-install.yml @@ -0,0 +1,28 @@ +name: Post-install/importing issue +description: Report an issue if you have trouble importing or using NumPy after installation. +labels: [32 - Installation] + +body: +- type: textarea + attributes: + label: "Steps to reproduce:" + description: > + Please describe the installation method (e.g. building from source, + Anaconda, pip), your OS and NumPy/Python version information. + validations: + required: true + +- type: textarea + attributes: + label: "Error message:" + description: > + Please include full error message, if any (starting from `Traceback: ...`). + 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). + render: shell + +- type: textarea + attributes: + label: "Additional information:" + description: Please add any additional information that could help us diagnose the problem better.
\ No newline at end of file |