From 13b95377fdd8b0b6228250b7927b947c97ad244c Mon Sep 17 00:00:00 2001 From: Marc Mezzarobba Date: Thu, 16 Mar 2023 09:05:19 +0100 Subject: [PATCH 1/3] put the actual description first in issue templates ...so that relevant information appears when hovering over items of the issue list, and so that one can read the actual issue on the issue page without scrolling over a full page of boilerplate. Also remove the title from the Description section of the PR template (same rationale). --- .github/ISSUE_TEMPLATE/bug_report.yml | 54 +++++++++++------------ .github/ISSUE_TEMPLATE/feature_report.yml | 14 +++--- .github/PULL_REQUEST_TEMPLATE.md | 2 - 3 files changed, 34 insertions(+), 36 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index f4ce719dcb8..3bf2378f927 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -3,33 +3,6 @@ description: Report a bug title: "" labels: "t: bug" body: - - type: checkboxes - attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. - options: - - label: I have searched the existing issues for a bug report that matches the one I want to file, without success. - required: true - - type: checkboxes - attributes: - label: Did you read the documentation and troubleshoot guide? - description: Please read [README.md](https://github.com/sagemath/sage/blob/develop/README.md) and [the Troubleshooting section in the Installation Guide](https://doc.sagemath.org/html/en/installation/troubles.html). - options: - - label: I have read the documentation and troubleshoot guide - required: true - - type: textarea - attributes: - label: Environment - description: | - examples: - - **OS**: Ubuntu 20.04 - - Sage Version: 9.2 - value: | - - **OS**: - - **Sage Version**: - render: markdown - validations: - required: true - type: textarea attributes: label: Steps To Reproduce @@ -60,3 +33,30 @@ body: Links? References? Anything that will give us more context about the issue you are encountering! validations: required: false + - type: textarea + attributes: + label: Environment + description: | + examples: + - **OS**: Ubuntu 20.04 + - Sage Version: 9.2 + value: | + - **OS**: + - **Sage Version**: + render: markdown + validations: + required: true + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues for a bug report that matches the one I want to file, without success. + required: true + - type: checkboxes + attributes: + label: Did you read the documentation and troubleshoot guide? + description: Please read [README.md](https://github.com/sagemath/sage/blob/develop/README.md) and [the Troubleshooting section in the Installation Guide](https://doc.sagemath.org/html/en/installation/troubles.html). + options: + - label: I have read the documentation and troubleshoot guide + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_report.yml b/.github/ISSUE_TEMPLATE/feature_report.yml index 5505a45143a..22db7acac68 100644 --- a/.github/ISSUE_TEMPLATE/feature_report.yml +++ b/.github/ISSUE_TEMPLATE/feature_report.yml @@ -3,13 +3,6 @@ description: Suggest an idea title: "<title>" labels: "t: enhancement" body: - - type: checkboxes - attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. - options: - - label: I have searched the existing issues for a bug report that matches the one I want to file, without success. - required: true - type: textarea attributes: label: Problem Description @@ -34,3 +27,10 @@ body: description: Add any other context about the problem here. validations: required: false + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues for a bug report that matches the one I want to file, without success. + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0ba5857b820..13a90cd2224 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,8 +3,6 @@ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes #1234" use "Introduce new method to calculate 1+1" --> -### 📚 Description - <!-- Describe your changes here in detail --> <!-- Why is this change required? What problem does it solve? --> <!-- If it resolves an open issue, please link to the issue here. For example "Closes #1337" --> From 2f302e6c3f150331fe1e1dc95a12e9e8d09b81e8 Mon Sep 17 00:00:00 2001 From: Marc Mezzarobba <marc@mezzarobba.net> Date: Thu, 16 Mar 2023 09:12:40 +0100 Subject: [PATCH 2/3] encourage PR submitters to remove checkboxes... ...that don't make sense with their particular PR --- .github/PULL_REQUEST_TEMPLATE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 13a90cd2224..555feed03d8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,6 +12,7 @@ For example, instead of "Fixes #1234" use "Introduce new method to calculate 1+1 <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> +<!-- Feel free to remove irrelevant items. --> - [ ] I have made sure that the title is self-explanatory and the description concisely explains the PR. - [ ] I have linked an issue or discussion. From d6d7630d1347165ce20f1cc9e5aebc98891b799d Mon Sep 17 00:00:00 2001 From: Marc Mezzarobba <marc@mezzarobba.net> Date: Thu, 16 Mar 2023 17:17:16 +0100 Subject: [PATCH 3/3] issue templates: move the instructions back to the beginning ...while keeping the checklist at the end. With this version, I thought it made sense to apply the change to ftbfs issues too. I left the "Environment" section near the beginning in that case, though it makes for a small inconsistency wrt the bug report template. --- .github/ISSUE_TEMPLATE/bug_report.yml | 13 +++++----- .../failure_building_from_source.yml | 25 +++++++++---------- .github/ISSUE_TEMPLATE/feature_report.yml | 5 +++- 3 files changed, 22 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 3bf2378f927..3d69721d33b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -3,6 +3,11 @@ description: Report a bug title: "<title>" labels: "t: bug" body: + - type: markdown + attributes: + value: | + * Please search to see if an issue already exists for the bug you encountered. + * Please read [README.md](https://github.com/sagemath/sage/blob/develop/README.md) and [the Troubleshooting section in the Installation Guide](https://doc.sagemath.org/html/en/installation/troubles.html). - type: textarea attributes: label: Steps To Reproduce @@ -48,15 +53,9 @@ body: required: true - type: checkboxes attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. + label: Checklist options: - label: I have searched the existing issues for a bug report that matches the one I want to file, without success. required: true - - type: checkboxes - attributes: - label: Did you read the documentation and troubleshoot guide? - description: Please read [README.md](https://github.com/sagemath/sage/blob/develop/README.md) and [the Troubleshooting section in the Installation Guide](https://doc.sagemath.org/html/en/installation/troubles.html). - options: - label: I have read the documentation and troubleshoot guide required: true diff --git a/.github/ISSUE_TEMPLATE/failure_building_from_source.yml b/.github/ISSUE_TEMPLATE/failure_building_from_source.yml index afe651bf14d..2575f5c9a10 100644 --- a/.github/ISSUE_TEMPLATE/failure_building_from_source.yml +++ b/.github/ISSUE_TEMPLATE/failure_building_from_source.yml @@ -4,20 +4,11 @@ title: "<title>" labels: ['c: build', 't: bug'] assignees: [] body: - - type: checkboxes + - type: markdown attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. - options: - - label: I have searched the existing issues for a bug report that matches the one I want to file, without success. - required: true - - type: checkboxes - attributes: - label: Did you read the documentation and troubleshoot guide? - description: Please read [README.md](https://github.com/sagemath/sage/blob/develop/README.md) and [the Troubleshooting sectionin the Installation Guide](https://doc.sagemath.org/html/en/installation/troubles.html). - options: - - label: I have read the documentation and troubleshoot guide - required: true + value: | + * Please search to see if an issue already exists for the bug you encountered. + * Please read [README.md](https://github.com/sagemath/sage/blob/develop/README.md) and [the Troubleshooting section in the Installation Guide](https://doc.sagemath.org/html/en/installation/troubles.html). - type: textarea attributes: label: Environment @@ -65,3 +56,11 @@ body: Links? References? Anything that will give us more context about the issue you are encountering! validations: required: false + - type: checkboxes + attributes: + label: Checklist + options: + - label: I have searched the existing issues for a bug report that matches the one I want to file, without success. + required: true + - label: I have read the documentation and troubleshoot guide + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_report.yml b/.github/ISSUE_TEMPLATE/feature_report.yml index 22db7acac68..9f291204fd3 100644 --- a/.github/ISSUE_TEMPLATE/feature_report.yml +++ b/.github/ISSUE_TEMPLATE/feature_report.yml @@ -3,6 +3,10 @@ description: Suggest an idea title: "<title>" labels: "t: enhancement" body: + - type: markdown + attributes: + value: | + * Please search to see if an issue already exists for the bug you encountered. - type: textarea attributes: label: Problem Description @@ -30,7 +34,6 @@ body: - type: checkboxes attributes: label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. options: - label: I have searched the existing issues for a bug report that matches the one I want to file, without success. required: true