From 05df2ad248638d55480e24ae7dbe79d318e18ac6 Mon Sep 17 00:00:00 2001
From: harryswift01 <harry.swift@stfc.ac.uk>
Date: Tue, 20 Jan 2026 10:08:02 +0000
Subject: [PATCH 1/2] add correct html comments within GitHub issues

---
 .github/ISSUE_TEMPLATE/bug_report.md     | 4 ++--
 .github/ISSUE_TEMPLATE/documentation.md  | 8 ++++----
 .github/ISSUE_TEMPLATE/general_report.md | 4 ++--
 3 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 6172382..9d94ca2 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -63,10 +63,10 @@ Remove unrelated fields to make it minimal. -->
 
 ## Screenshots or Logs
 
-Attach any relevant screenshots, logs, or stack traces.
+<!-- Attach any relevant screenshots, logs, or stack traces. -->
 
 ---
 
 ## Additional Context
 
-Include anything else that might help reproduce or understand the bug, such as changes from a previously working version.
+<!-- Include anything else that might help reproduce or understand the bug, such as changes from a previously working version. -->
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
index cf0f79a..9d0de48 100644
--- a/.github/ISSUE_TEMPLATE/documentation.md
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -7,13 +7,13 @@ assignees: ''
 ---
 
 ### Documentation Update
-What part of the documentation needs to be updated or added?
+<!-- What part of the documentation needs to be updated or added? -->
 
 ### Why Is This Needed?
-Explain the importance of this update.
+<!-- Explain the importance of this update. -->
 
 ### Suggested Changes
-Provide a detailed description of the changes.
+<!-- Provide a detailed description of the changes. -->
 
 ### Additional Context
-Include any related resources.
+<!-- Include any related resources. -->
diff --git a/.github/ISSUE_TEMPLATE/general_report.md b/.github/ISSUE_TEMPLATE/general_report.md
index 8538310..611e7c0 100644
--- a/.github/ISSUE_TEMPLATE/general_report.md
+++ b/.github/ISSUE_TEMPLATE/general_report.md
@@ -7,7 +7,7 @@ assignees: ''
 ---
 
 ### Feedback or Inquiry
-Provide your feedback or inquiry.
+<!-- Provide your feedback or inquiry. -->
 
 ### Additional Information
-Add any other relevant details here.
+<!-- Add any other relevant details here. -->

From 8a592a4d087ac8815b8640954ed3d800042684ee Mon Sep 17 00:00:00 2001
From: harryswift01 <harry.swift@stfc.ac.uk>
Date: Tue, 20 Jan 2026 11:01:56 +0000
Subject: [PATCH 2/2] remove repeated heading within the
 `.github/ISSUE_TEMPLATE/bug_report.md`

---
 .github/ISSUE_TEMPLATE/bug_report.md | 2 --
 1 file changed, 2 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 9d94ca2..b7215b1 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -8,8 +8,6 @@ assignees: ''
 ---
 
 # Bug Report
-
-**Describe the bug**  
 <!-- A clear and concise description of the issue. -->
 
 ---