From 98924ddac85011cc8b24f9932146f6f4bbbc5305 Mon Sep 17 00:00:00 2001 From: Julien Marrec Date: Mon, 27 Jan 2025 17:43:39 +0100 Subject: [PATCH] Use the form version, and clean up the inputs --- .github/ISSUE_TEMPLATE/01-bug-report.md | 26 ---------- .../{02-bug-report.yml => 01-bug-report.yml} | 51 +++---------------- ...request.yml => 02-enhancement-request.yml} | 0 .github/ISSUE_TEMPLATE/config.yml | 2 +- 4 files changed, 9 insertions(+), 70 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/01-bug-report.md rename .github/ISSUE_TEMPLATE/{02-bug-report.yml => 01-bug-report.yml} (52%) rename .github/ISSUE_TEMPLATE/{03-enhancement-request.yml => 02-enhancement-request.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.md b/.github/ISSUE_TEMPLATE/01-bug-report.md deleted file mode 100644 index f3e552a9416..00000000000 --- a/.github/ISSUE_TEMPLATE/01-bug-report.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Bug Report -about: Use this template for reporting an issue. -labels: Triage ---- - -Issue overview --------------- - - - -### Details - - - -- Platform (Operating system, version): -- Version of EnergyPlus (if using an intermediate build, include SHA): -- Unmethours link or helpdesk ticket number: - -### Checklist - - - -- [ ] Defect file added (list location of defect file here) -- [ ] Ticket added to EnergyPlus Defect Complexity (Github Project) -- [ ] Pull request created (the pull request will have additional tasks related to reviewing changes that fix this defect) diff --git a/.github/ISSUE_TEMPLATE/02-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml similarity index 52% rename from .github/ISSUE_TEMPLATE/02-bug-report.yml rename to .github/ISSUE_TEMPLATE/01-bug-report.yml index 3838b732552..033c61834ac 100644 --- a/.github/ISSUE_TEMPLATE/02-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -1,7 +1,6 @@ name: Bug Report Form -description: Use this template for reporting an issue, via a form +description: Use this template for reporting an issue. labels: Triage, UnconfirmedDefect - # projects: ["NREL/64"] body: - type: markdown attributes: @@ -23,21 +22,6 @@ body: validations: required: true - - type: dropdown - id: operating_system - attributes: - label: Operating System - multiple: false - description: What Operating System are you encountering issues on? - options: - - All - - Windows - - Ubuntu - - MacOS - - Other - validations: - required: true - - type: dropdown id: operating_system_multiple attributes: @@ -48,6 +32,7 @@ body: - Windows - Ubuntu - MacOS + - Any - Other validations: required: true @@ -79,31 +64,11 @@ body: required: false - type: textarea - id: env - attributes: - label: Details - description: Some additional details for this issue (if relevant) - value: | - - Platform (Operating system, version): - - Version of EnergyPlus (if using an intermediate build, include SHA): - - Unmethours link or helpdesk ticket number: - - - type: textarea - id: checklist + id: defect_file attributes: - label: Checklist - description: Add to this list or remove from it as applicable. This is a simple templated set of guidelines. - value: | - * [ ] Defect file added: - * [ ] Ticket added to EnergyPlus Defect Complexity (Github Project) - * [ ] Pull request created (the pull request will have additional tasks related to reviewing changes that fix this defect) + label: Defect file + description: | + You **can supply a link to your IDF if applicable**, or rename it to in.idf.txt and upload it directly here by drag and drop. - - type: checkboxes - id: checklist2 - attributes: - label: Checklist - description: Add to this list or remove from it as applicable. This is a simple templated set of guidelines. - options: - - label: Defect file added - - label: Ticket added to EnergyPlus Defect Complexity (Github Project) - - label: Pull request created (the pull request will have additional tasks related to reviewing changes that fix this defect) + Ideally, make it a Minimum, Complete, Verifiable Example (MCVE) by including the smallest possible number of input objects to reproduce the defect. + A good start might be to try to reproduce your issue with one of the [ExampleFiles](https://github.com/NREL/EnergyPlus/tree/develop/testfiles) diff --git a/.github/ISSUE_TEMPLATE/03-enhancement-request.yml b/.github/ISSUE_TEMPLATE/02-enhancement-request.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/03-enhancement-request.yml rename to .github/ISSUE_TEMPLATE/02-enhancement-request.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index d8d95d934b6..2029ba22a01 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - name: Unmet Hours url: https://unmethours.com