From 6a3f55a1b22c0774ed1f1fd11a2e6a451ea75b13 Mon Sep 17 00:00:00 2001 From: ianhi Date: Mon, 3 Aug 2020 12:13:54 -0400 Subject: [PATCH 1/8] add feature request template I also moved the ISSUE_TEMPLATE.md to ISSUE_TEMPLATE/bug_report.md so that both feature requests and bug report templates will show up after clicking the new issue button --- .../bug_report.md} | 5 +++ .github/ISSUE_TEMPLATE/feature_request.md | 34 +++++++++++++++++++ 2 files changed, 39 insertions(+) rename .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/bug_report.md} (95%) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/bug_report.md similarity index 95% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/bug_report.md index 617cabbc720a..dbd568cba01b 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,3 +1,8 @@ +--- +name: Bug Report +about: Report a bug or issue with Matplotlib +--- + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000000..e02c5a5e8fa4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,34 @@ +--- +name: Feature Request +about: Suggest something to add to Matplotlib +labels: New Feature +--- + + + +### Problem + + + +### Proposed Solution + + + +### Additional context + + \ No newline at end of file From e4f58f4994acd6f87c6089437f2ed2e4db2350a6 Mon Sep 17 00:00:00 2001 From: ianhi Date: Mon, 3 Aug 2020 23:55:08 -0400 Subject: [PATCH 2/8] tighten language --- .github/ISSUE_TEMPLATE/feature_request.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e02c5a5e8fa4..4c6f1df55e87 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -5,7 +5,7 @@ labels: New Feature --- @@ -26,7 +28,7 @@ Before creating a new feature request please search the issues for relevant feat * Add an option so that when [...] [...] will happen --> -### Additional context +### Additional context and prior art + + +### Problem + + + + +### Suggested Improvement + + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 000000000000..24b8bbf3eb8e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,26 @@ +--- +name: Enhancement +about: Help improve performance, usability and/or consistency. +label: Enhancement +--- + +### Describe the issue + +**Summary** + + + +**Code example** + + +```python +# paste your code here +# +# +``` + +### Proposed fix + From b75555d38daff226196951f37d865c7c92ae2c53 Mon Sep 17 00:00:00 2001 From: ianhi Date: Tue, 4 Aug 2020 00:00:54 -0400 Subject: [PATCH 4/8] use existing issue label --- .github/ISSUE_TEMPLATE/enhancement.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md index 24b8bbf3eb8e..f326e6d6db6b 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -1,7 +1,7 @@ --- name: Enhancement about: Help improve performance, usability and/or consistency. -label: Enhancement +label: maintenance --- ### Describe the issue From 47927a9a2eba42e0ad43ae04d6b6517d8c85c06f Mon Sep 17 00:00:00 2001 From: ianhi Date: Tue, 4 Aug 2020 19:21:52 -0400 Subject: [PATCH 5/8] add more examples + remove enhancement codesnippet Co-Authored-By: hannah --- .github/ISSUE_TEMPLATE/documentation.md | 3 ++- .github/ISSUE_TEMPLATE/enhancement.md | 12 ------------ .github/ISSUE_TEMPLATE/feature_request.md | 1 + 3 files changed, 3 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index 7f678cb64ce5..77db197d1d5c 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -26,4 +26,5 @@ If you have an idea to improve the documentation please suggest it here * This line should be be changed to say [...] * Include a paragraph explaining [...] ---> \ No newline at end of file +* Add a figure showing [...] +--> diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md index f326e6d6db6b..f1a1e7d7e0e3 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -10,17 +10,5 @@ label: maintenance -**Code example** - - -```python -# paste your code here -# -# -``` - ### Proposed fix diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 4c6f1df55e87..bd49f44bf442 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -19,6 +19,7 @@ Provide a clear and concise description of the problem this feature will solve. For example: * I'm always frustrated when [...] because [...] * I would like it if [...] happened when I [...] because [...] +* Here is a sample image of what I am asking for [...] --> ### Proposed Solution From 1f89ebf0192e1cad58c2e4242cacf3010177b36c Mon Sep 17 00:00:00 2001 From: ianhi Date: Tue, 11 Aug 2020 00:54:17 -0400 Subject: [PATCH 6/8] clarify maintenance template and create question template --- .../{enhancement.md => maintenance.md} | 2 +- .github/ISSUE_TEMPLATE/questions.md | 17 +++++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) rename .github/ISSUE_TEMPLATE/{enhancement.md => maintenance.md} (92%) create mode 100644 .github/ISSUE_TEMPLATE/questions.md diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/maintenance.md similarity index 92% rename from .github/ISSUE_TEMPLATE/enhancement.md rename to .github/ISSUE_TEMPLATE/maintenance.md index f1a1e7d7e0e3..7146a061acbd 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ b/.github/ISSUE_TEMPLATE/maintenance.md @@ -1,5 +1,5 @@ --- -name: Enhancement +name: Maintenance about: Help improve performance, usability and/or consistency. label: maintenance --- diff --git a/.github/ISSUE_TEMPLATE/questions.md b/.github/ISSUE_TEMPLATE/questions.md new file mode 100644 index 000000000000..58d742efc477 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/questions.md @@ -0,0 +1,17 @@ +--- +name: Question/Support/Other +about: If you have a usage question +labels: Question +# This template is based on the scikit-learn template +# https://github.com/scikit-learn/scikit-learn/blob/8e61534f1087703f476414d8dbd3688282f8eebf/.github/ISSUE_TEMPLATE/usage_question.md +--- + + From d9aee8eb2bd989d6cfbe21c31ff086dab935bde5 Mon Sep 17 00:00:00 2001 From: ianhi Date: Tue, 11 Aug 2020 21:20:28 -0400 Subject: [PATCH 7/8] correct labels of issue templates case sensitivity. Also put discourse link before SO to prioritize it. --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/ISSUE_TEMPLATE/maintenance.md | 2 +- .github/ISSUE_TEMPLATE/questions.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bd49f44bf442..6ca57f1ce8fa 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,7 +1,7 @@ --- name: Feature Request about: Suggest something to add to Matplotlib -labels: New Feature +labels: New feature ---