From 780b326bb8a577af42909ae7290c7b6f0ccad4b5 Mon Sep 17 00:00:00 2001
From: Harry Swift <harry.swift@stfc.ac.uk>
Date: Thu, 15 Jan 2026 11:03:22 +0000
Subject: [PATCH 1/8] Update issue templates

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 31 +++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++++
 2 files changed, 51 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..cd69305
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Operating System and Version (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..bbcbbe7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

From 523d71c0a1eeefe822aadab6e40a227145163c55 Mon Sep 17 00:00:00 2001
From: harryswift01 <harry.swift@stfc.ac.uk>
Date: Thu, 15 Jan 2026 11:28:37 +0000
Subject: [PATCH 2/8] Add tailored `bug_report.md` template for `CodeEntropy`
 bugs

---
 .github/ISSUE_TEMPLATE/bug_report.md | 57 +++++++++++++++++++---------
 1 file changed, 40 insertions(+), 17 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index cd69305..79c09d6 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,31 +1,54 @@
+
 ---
 name: Bug report
 about: Create a report to help us improve
 title: ''
 labels: bug
 assignees: ''
+---
+
+# Bug Report
+
+**Describe the bug**  
+<!-- A clear and concise description of the issue. -->
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+## To Reproduce  
+<!-- Provide a minimal YAML configuration and the exact CLI command that reproduces the issue. -->
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+### YAML configuration
+<!-- Paste the YAML file or the smallest excerpt that reproduces the issue.  
+Remove unrelated fields to make it minimal. -->
+```yaml
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+```
+
+### CLI command used
+<!-- Write the exact command used, for example:   -->
+```bash
+```
+
+### Actual output
+<!-- Paste the output, logs, or error messages here. -->
+
+Describe what you expected to see instead.
+---
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+## Environment and Versions
+
+- CodeEntropy Version:
+- OS: e.g., Ubuntu 22.04  
+- Python Version: e.g., 
+
+---
+
+## Screenshots or Logs
+
+Attach any relevant screenshots, logs, or stack traces.
+
+---
 
-**Operating System and Version (please complete the following information):**
- - OS: [e.g. iOS]
- - Version [e.g. 22]
+## Additional Context
 
-**Additional context**
-Add any other context about the problem here.
+Include anything else that might help reproduce or understand the bug, such as changes from a previously working version.

From 4ddbd8f678326ef60ca425b1b0cd932d0c3bcc37 Mon Sep 17 00:00:00 2001
From: harryswift01 <harry.swift@stfc.ac.uk>
Date: Thu, 15 Jan 2026 11:33:24 +0000
Subject: [PATCH 3/8] polish `bug_report.md` template

---
 .github/ISSUE_TEMPLATE/bug_report.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 79c09d6..13f9d27 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -5,6 +5,7 @@ about: Create a report to help us improve
 title: ''
 labels: bug
 assignees: ''
+
 ---
 
 # Bug Report
@@ -31,15 +32,14 @@ Remove unrelated fields to make it minimal. -->
 
 ### Actual output
 <!-- Paste the output, logs, or error messages here. -->
-
 Describe what you expected to see instead.
 ---
 
 ## Environment and Versions
 
 - CodeEntropy Version:
-- OS: e.g., Ubuntu 22.04  
-- Python Version: e.g., 
+- OS: 
+- Python Version:
 
 ---
 

From db9a525be5bec4dc46f20a1626e60980a78f6f8d Mon Sep 17 00:00:00 2001
From: harryswift01 <harry.swift@stfc.ac.uk>
Date: Thu, 15 Jan 2026 11:38:04 +0000
Subject: [PATCH 4/8] refined `bug_report.md` template

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

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 13f9d27..3279a24 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -16,7 +16,7 @@ assignees: ''
 ---
 
 ## To Reproduce  
-<!-- Provide a minimal YAML configuration and the exact CLI command that reproduces the issue. -->
+<!-- Provide the YAML configuration and the exact CLI command that reproduces the issue. -->
 
 ### YAML configuration
 <!-- Paste the YAML file or the smallest excerpt that reproduces the issue.  
@@ -28,11 +28,12 @@ Remove unrelated fields to make it minimal. -->
 ### CLI command used
 <!-- Write the exact command used, for example:   -->
 ```bash
+
 ```
 
 ### Actual output
 <!-- Paste the output, logs, or error messages here. -->
-Describe what you expected to see instead.
+### Describe what you expected to see instead.
 ---
 
 ## Environment and Versions

From 4a120380725c5b657d840a1f0da5a717edce3684 Mon Sep 17 00:00:00 2001
From: harryswift01 <harry.swift@stfc.ac.uk>
Date: Thu, 15 Jan 2026 11:47:04 +0000
Subject: [PATCH 5/8] include placeholder comments within code blocks and
 simplify headings

---
 .github/ISSUE_TEMPLATE/bug_report.md | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 3279a24..2b69f24 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -22,18 +22,21 @@ assignees: ''
 <!-- Paste the YAML file or the smallest excerpt that reproduces the issue.  
 Remove unrelated fields to make it minimal. -->
 ```yaml
-
+# Paste the YAML snippet here
 ```
 
 ### CLI command used
 <!-- Write the exact command used, for example:   -->
 ```bash
-
+# Paste the CLI command here
 ```
 
 ### Actual output
-<!-- Paste the output, logs, or error messages here. -->
-### Describe what you expected to see instead.
+<!-- Paste the output, logs, or error messages here -->
+
+### Expected output
+<!-- Describe what you expected to see instead -->
+
 ---
 
 ## Environment and Versions

From 54e76268fa846916529f69443913adfb6f05f244 Mon Sep 17 00:00:00 2001
From: harryswift01 <harry.swift@stfc.ac.uk>
Date: Thu, 15 Jan 2026 11:54:06 +0000
Subject: [PATCH 6/8] refine `feature_request.md` template tailored for
 `CodeEntropy`

---
 .github/ISSUE_TEMPLATE/feature_request.md | 27 +++++++++++++++--------
 1 file changed, 18 insertions(+), 9 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index bbcbbe7..e74a335 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,20 +1,29 @@
+
 ---
 name: Feature request
 about: Suggest an idea for this project
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+# Feature Request
+
+## Problem / Motivation
+<!-- Describe the problem you want to solve or the motivation for this feature. -->
+
+## Proposed Solution
+<!-- Describe the feature you would like to see implemented. Include examples if applicable. -->
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+## Alternatives Considered
+- <!-- Alternative 1 -->
+- <!-- Alternative 2 -->
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+## Expected Impact
+<!-- How this feature would affect the codebase or workflow -->
+- <!-- Impact 1 -->
+- <!-- Impact 2 -->
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+## Additional Context
+<!-- Add any other context, screenshots, or references for the feature request here. -->
+- <!-- Further context -->

From bd70da0eeae300c65854348c42c5f2150eb6c9ba Mon Sep 17 00:00:00 2001
From: harryswift01 <harry.swift@stfc.ac.uk>
Date: Thu, 15 Jan 2026 12:09:16 +0000
Subject: [PATCH 7/8] add packaging list  to environment and versions section

---
 .github/ISSUE_TEMPLATE/bug_report.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 2b69f24..3c0e69c 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -33,6 +33,9 @@ Remove unrelated fields to make it minimal. -->
 
 ### Actual output
 <!-- Paste the output, logs, or error messages here -->
+```bash
+# Paste the output, logs, or error messages here
+```
 
 ### Expected output
 <!-- Describe what you expected to see instead -->
@@ -44,6 +47,18 @@ Remove unrelated fields to make it minimal. -->
 - CodeEntropy Version:
 - OS: 
 - Python Version:
+- Package list:
+  - If using conda, run: `conda list > packages.txt` and paste the contents here.
+    
+    ``` bash
+    # Paste packages.txt here
+    ```
+
+  - If using venv/pip, run: `pip list > packages.txt` and paste the contents here.
+
+    ``` bash
+    # Paste packages.txt here
+    ```
 
 ---
 

From b180c63286e1b64e09a46fc90b7d2efbc876c1ae Mon Sep 17 00:00:00 2001
From: harryswift01 <harry.swift@stfc.ac.uk>
Date: Thu, 15 Jan 2026 12:12:11 +0000
Subject: [PATCH 8/8] update order of the enviornment and versions section

---
 .github/ISSUE_TEMPLATE/bug_report.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 3c0e69c..815a577 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -44,8 +44,8 @@ Remove unrelated fields to make it minimal. -->
 
 ## Environment and Versions
 
+- Operating System:
 - CodeEntropy Version:
-- OS: 
 - Python Version:
 - Package list:
   - If using conda, run: `conda list > packages.txt` and paste the contents here.