summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMelissaWM <melissawm@gmail.com>2020-09-02 16:12:04 -0300
committerMelissaWM <melissawm@gmail.com>2020-09-02 16:21:47 -0300
commit0a921a8d282e41127c85d504e2569bfea05a7ec0 (patch)
tree3909865616e9a47a82f93326f946d8ca513d7a2b
parentdb866874ccb8c8c814df57eb1edca4fd05eb1753 (diff)
downloadnumpy-0a921a8d282e41127c85d504e2569bfea05a7ec0.tar.gz
DOC: Added templates for different types of issues.
-rw-r--r--.github/ISSUE_TEMPLATE/bug-report.md30
-rw-r--r--.github/ISSUE_TEMPLATE/documentation.md21
-rw-r--r--.github/ISSUE_TEMPLATE/feature-request.md15
-rw-r--r--.github/ISSUE_TEMPLATE/questions-help-support.md16
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md4
5 files changed, 86 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
new file mode 100644
index 000000000..123498224
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,30 @@
+---
+name: "Bug Report"
+about: Submit a bug report to help us improve NumPy
+
+---
+
+<!-- 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/master/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/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
new file mode 100644
index 000000000..cc249e33f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -0,0 +1,21 @@
+---
+name: "Documentation"
+about: Report an issue related to the NumPy documentation
+
+---
+
+## Documentation
+
+<!-- If this is an issue with the current documentation for NumPy (i.e.
+incomplete/innacurate docstring, unclear explanation in any part of the
+documentation), make sure to leave a reference to the document/code you're
+referring to. -->
+
+<!-- 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. -->
+
+<!-- If this is about the content in https://numpy.org, please open an issue at
+the https://github.com/numpy/numpy.org repo instead. -->
+
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
new file mode 100644
index 000000000..96faf6aab
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -0,0 +1,15 @@
+---
+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, please
+post your idea on the [numpy-discussion mailing list]
+(https://mail.python.org/mailman/listinfo/numpy-discussion) to explain your
+reasoning before you open an issue or pull request. You can also check out our
+[Contributor Guide]
+(https://github.com/numpy/numpy/blob/master/doc/source/dev/index.rst) if you
+need more information.
diff --git a/.github/ISSUE_TEMPLATE/questions-help-support.md b/.github/ISSUE_TEMPLATE/questions-help-support.md
new file mode 100644
index 000000000..c170ed374
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/questions-help-support.md
@@ -0,0 +1,16 @@
+---
+name: "Questions/Help/Support"
+about: Resources to get help and support about NumPy.
+
+---
+
+## Questions and Help
+
+### Please note that this issue tracker is not a help form and this issue will
+be closed.
+
+If you need help, we have a set of [listed resources available on the website]
+(https://numpy.org/gethelp/).
+
+For NumPy development-related matters, please see [Community]
+(https://numpy.org/community/).
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index e12eea7bd..1f313fd75 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,3 +5,7 @@ http://www.numpy.org/devdocs/dev/development_workflow.html
<!-- We'd appreciate it if your commit message is properly formatted
http://www.numpy.org/devdocs/dev/development_workflow.html#writing-the-commit-message
-->
+
+<!-- If you're submitting a new feature or substantial change in funcionality,
+make sure you discuss your changes in the numpy-discussion mailing list first:
+https://mail.python.org/mailman/listinfo/numpy-discussion -->