Merge pull request #245 from alphagov/github/update-workflows

- add updated issue and pull request templates

Author: jamescarr28

.github/ISSUE_TEMPLATE.md

@@ -1,14 +1,28 @@
-<!--
-## Please fill in the sections below
+## Proposed changes
 
-After you submit your pull request, the technical writing team from the Central Digital and Data Office (CDDO) will discuss and prioritise it at our fortnightly triage meeting. We’ll then let you know if and when we’ll move it forward.
--->
+### What changed
 
-## What’s changed
+Describe the changes made and the impact the changes have.
 
-<!-- What are you trying to do? Is this something that changes how the Tech Docs Template behaves, or is it fixing a bug? -->
+## Related issue or tracking reference
 
+You should have an open GitHub issue that this PR will fix.  
 
-## Identifying a user need
+- Fixes #
+- Relates to #
 
-<!-- Do you have evidence that this meets the needs of users? Let us know about any user research or testing you’ve done. -->
+> If there is no issue, please open one or please explain why one is not needed (for example small maintenance change, routine dependency update).
+
+## Screenshots or examples (if relevant)
+
+Include screenshots, logs, or rendered output if this change affects layout or behaviour.
+
+## Checklist
+
+Before you request approval you should confirm that:
+
+- [ ] the pull request has a clear title with a short description about the update in the documentation
+- [ ] GitHub actions all pass
+- [ ] you have tested the changes with a fresh build against the latest version of the `tech-docs-gem`
+- [ ] you have linked this PR to an issue (or explained why none exists)
+- [ ] you have updated documentation if needed

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,51 @@
+name: 🐛 Bug report
+description: Something is broken or not working as expected
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for reporting a bug in `tech-docs-template`
+        Please include as much detail as you can.  This will help us prioritise this issue correctly.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: What happened?
+      description: Describe the problem and what you expected to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to reproduce
+      description: |
+        Tell us how to reproduce the issue.
+        Example:
+        1. Run `bundle exec middleman serve`
+        2. Visit `/guides/setup`
+        3. See white screen of death
+      placeholder: Step-by-step instructions
+    validations:
+      required: false
+
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs or error output
+      description:
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Checks
+      options:
+        - label: I have searched for existing issues
+          required: true
+        - label: I have checked other users also have this issue
+          required: true
+        - label: I have checked that I am not using a local or forked repository with untested changes
+          required: true

ISSUE_TEMPLATE/bug.yaml

@@ -0,0 +1,9 @@
+
+blank_issues_enabled: false
+contact_links:
+  - name: Create a new project
+    url: https://github.com/alphagov/tdt-documentation/tree/main/source/create_project
+    about: Information for creating and configuring a new project
+  - name: Ask a question or get help
+    url: https://ukgovernmentdigital.slack.com/archives/C1ZM2T0SG
+    about: Uk Government digital slack channel for Technical Writers

ISSUE_TEMPLATE/config.yaml

@@ -0,0 +1,25 @@
+name: ✨ New or updated feature
+description: Suggest a new feature or improvement
+title: "[Enhancement]: "
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: What should change?
+      description: What would fix the issue? Is this something you think should behave differently, or something that you currently cannot do?
+    validations:
+      required: true
+
+  - type: textarea
+    id: user need
+    attributes:
+      label: User need
+      description: Do you have evidence that the change will meet the needs of users? Let us know about any user research or testing you’ve done
+
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+      description: Optional — describe how you think this could work or a solution you have in mind
+