From bb0a0042e0e0d4aa2976de196f9d9001cca6d1b5 Mon Sep 17 00:00:00 2001 From: Parikshit Bajpai Date: Wed, 17 Apr 2024 21:28:51 -0600 Subject: [PATCH 1/2] Start working on YAML based template for issues --- .github/ISSUE_TEMPLATE/bug_report.yaml | 64 ++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..f1376d33 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,64 @@ +name: Bug Report +description: Create a report to help us improve +title: "[Bug]: " +labels: ["bug", "triage"] +projects: ["octo-org/1", "octo-org/44"] +assignees: + - octocat +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true + - type: dropdown + id: version + attributes: + label: Version + description: What version of our software are you running? + options: + - 1.0.2 (Default) + - 1.0.3 (Edge) + default: 0 + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com). + options: + - label: I agree to follow this project's Code of Conduct + required: true From 93c1d198616f0a427c8e54c48bd47bb1a8630252 Mon Sep 17 00:00:00 2001 From: Parikshit Bajpai Date: Wed, 17 Apr 2024 21:52:53 -0600 Subject: [PATCH 2/2] YAML based issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 31 ----- .github/ISSUE_TEMPLATE/bug_report.yaml | 119 ++++++++++---------- .github/ISSUE_TEMPLATE/feature_request.md | 20 ---- .github/ISSUE_TEMPLATE/feature_request.yaml | 39 +++++++ 4 files changed, 97 insertions(+), 112 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 42b58a64..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: - -**Input** -Please provide a .F90 or .ti input that reproduces the problem. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**System (please complete the following information):** - - OS: [e.g. Ubuntu 20.04] - - Compiler: [e.g. gfortran 5.4.0] - -**Commit:** - - Branch: [e.g. master] - - Commit hash: [e.g. 34ee1c02b7bac62220e80a040bea950704398c6b] diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index f1376d33..caef346b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -1,64 +1,61 @@ name: Bug Report -description: Create a report to help us improve -title: "[Bug]: " -labels: ["bug", "triage"] -projects: ["octo-org/1", "octo-org/44"] -assignees: - - octocat +description: Create a report to help us fix bugs +title: "[BUG] " +labels: ["Bug", "Needs Triage"] body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug report! - - type: input - id: contact - attributes: - label: Contact Details - description: How can we get in touch with you if we need more info? - placeholder: ex. email@example.com - validations: - required: false - - type: textarea - id: what-happened - attributes: - label: What happened? - description: Also tell us, what did you expect to happen? - placeholder: Tell us what you see! - value: "A bug happened!" - validations: +- 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 required: true - - type: dropdown - id: version - attributes: - label: Version - description: What version of our software are you running? - options: - - 1.0.2 (Default) - - 1.0.3 (Edge) - default: 0 - validations: - required: true - - type: dropdown - id: browsers - attributes: - label: What browsers are you seeing the problem on? - multiple: true - options: - - Firefox - - Chrome - - Safari - - Microsoft Edge - - type: textarea - id: logs - attributes: - label: Relevant log output - description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. - render: shell - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com). - options: - - label: I agree to follow this project's Code of Conduct - required: true +- type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true +- type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: false +- type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 1. With this config... + 1. Run '...' + 1. See error... + validations: + required: false +- type: textarea + attributes: + label: Environment + description: | + examples: + - **OS**: Ubuntu 20.04 + - **Compiler**: gfortran 5.4.0 + - **Python**: 3.12.0 + value: | + - OS: + - Compiler: + - Python: + - Branch: + - Commit Hash: + render: markdown + validations: + required: false +- type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 63b31dd4..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Reason.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Proposed Solution** -A clear and concise description of what you want to happen. - -**Impact** -A clear and concise description of any consequences you can foresee. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..722af528 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,39 @@ +name: Feature Request +description: Create a request for new features / enhancements +title: "[ENHANCEMENT] <title>" +labels: ["Enhancement", "Needs Triage"] +body: +- type: checkboxes + attributes: + label: Is there an existing issue or PR for this? + description: Please search to see if an issue or PR already exists for the feature you are requesting. + options: + - label: I have searched the existing issues and PRs + required: true +- type: textarea + attributes: + label: Reasoning + description: A concise description of what you are interested in. + validations: + required: true +- type: textarea + attributes: + label: Proposed Solution + description: A concise description of what you want to happen and how it should be implemented. + validations: + required: false +- type: textarea + attributes: + label: Impact + description: A concise description of any consequences you can foresee. + validations: + required: false +- type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about your request! + + Tip: You can attach images, etc. by clicking this area to highlight it and then dragging files in. + validations: + required: false