From 2e50b2d548ffed5b8a7c4d21bfbd87c789eac640 Mon Sep 17 00:00:00 2001 From: hannah Date: Tue, 20 Jul 2021 01:16:53 -0400 Subject: [PATCH 1/4] issue forms + fixed formatting on github --- .github/ISSUE_TEMPLATE/bug_report.yml | 91 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.yml | 51 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 36 +++++++++ .github/ISSUE_TEMPLATE/maintenance.yml | 17 ++++ 4 files changed, 195 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/maintenance.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000000..aa788b13556a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,91 @@ +name: Bug Report +description: Report a bug or issue with Matplotlib +title: "[Bug]: " +body: + - type: markdown + attributes: + value: | + To help us understand and resolve your issue, please fill out the form to the best of your ability. + - type: textarea + id: summary + attributes: + label: Bug summary + description: Please provide 1-2 short sentences that succinctly describes the bug + placeholder: + value: + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Code for reproduction + description: Please provide the minimum code required to reproduce the bug. Please make sure to minimize the number of dependencies required, and provide any necessary plotted data. Avoid using threads, as Matplotlib is (explicitly) not thread-safe. + placeholder: Paste your code here + render: python + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual outcome + description: Please provide the output produced by the above code, which may be a screenshot, console output, etc. + placeholder: if applicable, paste the console output and images here + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected outcome + description: Please provide a description (or visual example) of the expected outcome from the code snippet. If this used to work in an earlier version of Matplotlib, please note the version it used to work on + validations: + required: true + - type: input + id: operating-system + attributes: + label: Operating system + description: What operating system are you using? + placeholder: Windows, OS/X, Arch, Debian, Ubuntu, etc. + - type: input + id: matplotlib-version + attributes: + label: Matplotlib Version + placeholder: import matplotlib; print(matplotlib.__version__) + validations: + required: true + - type: input + id: matplotlib-backend + attributes: + label: Matplotlib Backend + placeholder: print(matplotlib.get_backend()) + validations: + required: true + - type: input + id: python-version + attributes: + label: Python version + placeholder: python --version + - type: input + id: jupyter-version + attributes: + label: Jupyter version + placeholder: jupyter notebook --version, jupyter lab --version + - type: textarea + id: other-libraries + attributes: + label: Other libraries + description: please provide the versions of any other libraries that are relevant to this bug report. + - type: dropdown + id: install + attributes: + label: Installation + description: how did you install matplotlib? + options: + - pip + - conda + - source + - type: input + id: conda-channel + attributes: + label: Conda channel + description: If you installed from conda, please specify which channel you used if not the default? + placeholder: conda-forge diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 000000000000..d4b9eadd5b70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,51 @@ +name: Documentation +description: Create a report to help us improve the documentation +title: "[Doc]: " +labels: [Documentation] +body: + - type: markdown + attributes: + value: | + To help us understand and resolve your issue, please fill out the form to the best of your ability. + - type: input + id: link + attributes: + label: Documentation Link + description: Please provide a link to any documentation or examples that you are referencing. + placeholder: https://matplotlib.org/devdocs/ + - type: textarea + id: problem + attributes: + label: Problem + description: What is missing, unclear, or wrong in the documentation? + placeholder: | + * I found [...] to be unclear because [...] + * [...] made me think that [...] when really it should be [...] + * There is no example showing how to do [...] + validations: + required: true + - type: textarea + id: improvement + attributes: + label: Suggested improvement + description: How can we improve the documentation? + placeholder: | + * This line should be be changed to say [...] + * Include a paragraph explaining [...] + * Add a figure showing [...] + - type: input + id: matplotlib-version + attributes: + label: Matplotlib Version + placeholder: import matplotlib; print(matplotlib.__version__) + validations: + required: true + - type: input + id: matplotlib-doc-version + attributes: + label: Matplotlib documentation version + placeholder: check under the logo + validations: + required: true + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000000..4fbef25bf53b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,36 @@ +name: Feature Request +description: Suggest something to add to Matplotlib! +title: "[ENH]: " +labels: [New feature] +body: + - type: markdown + attributes: + value: | + Thanks for thinking of a way to improve Matplotlib. Please search the issues for relevant feature requests before creating a new feature request. + - type: textarea + id: problem + attributes: + label: Problem + description: Please provide a clear and concise description of the problem this feature will solve. + placeholder: | + * 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 [...] + validations: + required: true + - type: textarea + id: solution + attributes: + label: Proposed solution + description: Please provide a clear and concise description of a way to accomplish what you want. + placeholder: Add an option so that when [...] [...] will happen + - type: textarea + id: prior-art + attributes: + label: Additional context and prior art + description: Add any other context or screenshots about the feature request here. You can also include links to examples of other programs that have something similar to your request. + placeholder: Another project [...] solved this by [...] + + + + diff --git a/.github/ISSUE_TEMPLATE/maintenance.yml b/.github/ISSUE_TEMPLATE/maintenance.yml new file mode 100644 index 000000000000..eb2458dda6e8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/maintenance.yml @@ -0,0 +1,17 @@ +name: Maintenance +description: Help improve performance, usability and/or consistency. +title: "[MNT]: " +labels: [Maintenance] +body: + - type: textarea + id: summary + attributes: + label: Summary + description: Please provide 1-2 short sentences that succinctly describes what could be improved. + validations: + required: true + - type: textarea + id: fix + attributes: + label: Proposed fix + description: Please describe how you think this could be improved. From 68f7847791bc4b14a7f0424f1d8cf05c50903d62 Mon Sep 17 00:00:00 2001 From: hannah Date: Fri, 23 Jul 2021 13:12:00 -0400 Subject: [PATCH 2/4] removed issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 54 ----------------------- .github/ISSUE_TEMPLATE/documentation.md | 35 --------------- .github/ISSUE_TEMPLATE/feature_request.md | 37 ---------------- .github/ISSUE_TEMPLATE/maintenance.md | 14 ------ 4 files changed, 140 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/maintenance.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 35a1beb9b2a6..000000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: Bug Report -about: Report a bug or issue with Matplotlib ---- - - - - -### Bug report - -**Bug summary** - - - -**Code for reproduction** - - - -```python -# Paste your code here -# -# -``` - -**Actual outcome** - - - -``` -# If applicable, paste the console output here -# -# -``` - -**Expected outcome** - - - - -**Matplotlib version** - - * Operating system: - * Matplotlib version (`import matplotlib; print(matplotlib.__version__)`): - * Matplotlib backend (`print(matplotlib.get_backend())`): - * Python version: - * Jupyter version (if applicable): - * Other libraries: - - - - diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 50b29f2dff10..000000000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Documentation improvement -about: Create a report to help us improve the documentation -labels: Documentation ---- - - - - -### Problem - - - - -### Suggested Improvement - - - -**Matplotlib version** - - * Operating system: - * Matplotlib version (`import matplotlib; print(matplotlib.__version__)`): - * Matplotlib documentation version (is listed under the logo): diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 6ca57f1ce8fa..000000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Feature Request -about: Suggest something to add to Matplotlib -labels: New feature ---- - - - -### Problem - - - -### Proposed Solution - - - -### Additional context and prior art - - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/maintenance.md b/.github/ISSUE_TEMPLATE/maintenance.md deleted file mode 100644 index a72282892d85..000000000000 --- a/.github/ISSUE_TEMPLATE/maintenance.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Maintenance -about: Help improve performance, usability and/or consistency. -labels: Maintenance ---- - -### Describe the issue - -**Summary** - - - -### Proposed fix - From 8dc85172538074c9ee87bb76b361010627faee22 Mon Sep 17 00:00:00 2001 From: hannah Date: Sun, 25 Jul 2021 21:03:39 -0400 Subject: [PATCH 3/4] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index aa788b13556a..95bda9b8f206 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -19,7 +19,7 @@ body: id: reproduction attributes: label: Code for reproduction - description: Please provide the minimum code required to reproduce the bug. Please make sure to minimize the number of dependencies required, and provide any necessary plotted data. Avoid using threads, as Matplotlib is (explicitly) not thread-safe. + description: If possible, please provide a minimum self-contained example. placeholder: Paste your code here render: python validations: @@ -57,8 +57,6 @@ body: attributes: label: Matplotlib Backend placeholder: print(matplotlib.get_backend()) - validations: - required: true - type: input id: python-version attributes: From ead7a408b2496fb47fd57d90737eac8a9d3b3171 Mon Sep 17 00:00:00 2001 From: hannah Date: Tue, 27 Jul 2021 12:38:08 -0400 Subject: [PATCH 4/4] added linux package manager option --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 95bda9b8f206..87f566657fe3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -80,6 +80,7 @@ body: options: - pip - conda + - Linux package manager (Debian/Fedora/etc.) - source - type: input id: conda-channel