From b56dd87dcc1c4cbaaad86659f1c6f39fb02532e4 Mon Sep 17 00:00:00 2001 From: Laurence Weir <189218292+LaurenceSignaloid@users.noreply.github.com> Date: Mon, 2 Mar 2026 13:52:23 +0000 Subject: [PATCH 1/2] Create 00-public-bug-issue-template-v1.yml --- .../00-public-bug-issue-template-v1.yml | 79 +++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/00-public-bug-issue-template-v1.yml diff --git a/.github/ISSUE_TEMPLATE/00-public-bug-issue-template-v1.yml b/.github/ISSUE_TEMPLATE/00-public-bug-issue-template-v1.yml new file mode 100644 index 0000000..d24d64e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/00-public-bug-issue-template-v1.yml @@ -0,0 +1,79 @@ +name: "Bug Report" +description: "File a structured report to help us reproduce and fix an issue." +title: "[Bug]: " +type: "bug" +body: + - type: markdown + attributes: + value: | + ### Thank you for reporting a bug! + To help us resolve this as quickly as possible, please provide as much detail as you can. Before submitting, please ensure you are using the latest version of our tools. + + - type: textarea + id: what-happened + attributes: + label: "What happened?" + description: "A clear and concise description of the bug." + placeholder: "I expected the SCDP to return a specific distribution, but instead it..." + validations: + required: true + + - type: textarea + id: reproduction-steps + attributes: + label: "Steps to Reproduce" + description: "How can we make this happen again? Code snippets are highly encouraged." + placeholder: | + 1. Run 'signaloid-cli load...' + 2. Set parameters to... + 3. See error... + validations: + required: true + + - type: dropdown + id: environment + attributes: + label: "Environment" + description: "Where did you encounter the issue?" + options: + - Signaloid Cloud Developer Platform (Browser) + - Signaloid CLI / Local Execution + - FPGA / Hardware Target + - Documentation / Website + validations: + required: true + + - type: input + id: version + attributes: + label: "Version / Commit Hash" + description: "Which version of the Signaloid toolchain or API are you using?" + placeholder: "e.g., v2.1.0 or commit a1b2c3d" + validations: + required: true + + - type: dropdown + id: os + attributes: + label: "Operating System" + options: + - Linux + - macOS + - Windows + - Other (Cloud Platform) + + - type: textarea + id: logs + attributes: + label: "Relevant log output or Trace" + description: "Please paste any compiler errors, CLI output, or console logs here." + render: shell + placeholder: "Paste logs here..." + + - type: textarea + id: visual-evidence + attributes: + label: "Screenshots or Diagrams" + description: "Drag and drop images here (especially helpful for SCDP UI bugs or plots)." + validations: + required: false From d4773e0d88931550650f47ac6418445377a79451 Mon Sep 17 00:00:00 2001 From: Laurence Weir <189218292+LaurenceSignaloid@users.noreply.github.com> Date: Mon, 2 Mar 2026 15:11:30 +0000 Subject: [PATCH 2/2] Update 00-public-bug-issue-template-v1.yml --- .../00-public-bug-issue-template-v1.yml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/00-public-bug-issue-template-v1.yml b/.github/ISSUE_TEMPLATE/00-public-bug-issue-template-v1.yml index d24d64e..b9138e3 100644 --- a/.github/ISSUE_TEMPLATE/00-public-bug-issue-template-v1.yml +++ b/.github/ISSUE_TEMPLATE/00-public-bug-issue-template-v1.yml @@ -7,14 +7,15 @@ body: attributes: value: | ### Thank you for reporting a bug! - To help us resolve this as quickly as possible, please provide as much detail as you can. Before submitting, please ensure you are using the latest version of our tools. + To help us resolve this as quickly as possible, please provide as much detail as you can. + Before submitting, please ensure you are using the latest version of our tools. - type: textarea id: what-happened attributes: label: "What happened?" description: "A clear and concise description of the bug." - placeholder: "I expected the SCDP to return a specific distribution, but instead it..." + placeholder: "e.g., I expected the Signaloid Cloud Developer Platform (SCDP) to return a specific distribution, but instead it..." validations: required: true @@ -22,7 +23,7 @@ body: id: reproduction-steps attributes: label: "Steps to Reproduce" - description: "How can we make this happen again? Code snippets are highly encouraged." + description: "How can we make this happen again? You can provide a list of steps, specific inputs, or a relevant code snippet." placeholder: | 1. Run 'signaloid-cli load...' 2. Set parameters to... @@ -38,8 +39,9 @@ body: options: - Signaloid Cloud Developer Platform (Browser) - Signaloid CLI / Local Execution - - FPGA / Hardware Target + - Signaloid Compute Modules (e.g, C0-microSD) - Documentation / Website + - Other validations: required: true @@ -74,6 +76,6 @@ body: id: visual-evidence attributes: label: "Screenshots or Diagrams" - description: "Drag and drop images here (especially helpful for SCDP UI bugs or plots)." + description: "Drag and drop images here." validations: required: false