Skip to content

Commit de071ae

Browse files
JC-DSITJC-DSIT
authored
Merge pull request #470 from alphagov/gihub-workflows
- add templates for different issue types - add dependency quality gate to github workflow
2 parents a5df4d9 + 9ca6e9a commit de071ae

6 files changed

Lines changed: 139 additions & 21 deletions

File tree

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug.yaml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: 🐛 Bug report
2+
description: Something is broken or not working as expected
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for reporting a bug in `tech-docs-gem`
10+
Please include as much detail as you can. This will help us prioritise this issue correctly.
11+
12+
- type: textarea
13+
id: tech-docs-gem-version
14+
attributes:
15+
label: tech-docs-gem version
16+
description: Which version of the tech docs gem are you using
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: ruby-version
22+
attributes:
23+
label: ruby version
24+
description: Which version of the ruby are you using (if known)
25+
validations:
26+
required: false
27+
28+
- type: textarea
29+
id: description
30+
attributes:
31+
label: What happened?
32+
description: Describe the problem and what you expected to happen.
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: reproduction
38+
attributes:
39+
label: Steps to reproduce
40+
description: |
41+
Tell us how to reproduce the issue.
42+
Example:
43+
1. Run `bundle exec middleman serve`
44+
2. Visit `/guides/setup`
45+
3. See white screen of death
46+
placeholder: Step-by-step instructions
47+
validations:
48+
required: true
49+
50+
51+
- type: textarea
52+
id: logs
53+
attributes:
54+
label: Logs or error output
55+
description: Any error messages or logs if available
56+
validations:
57+
required: false
58+
59+
- type: checkboxes
60+
id: checks
61+
attributes:
62+
label: Checks
63+
options:
64+
- label: I have searched for existing issues
65+
required: true
66+
- label: I have checked other users also have this issue
67+
required: true
68+
- label: I have checked that I am not using a local or forked repository with untested changes
69+
required: true

‎.github/ISSUE_TEMPLATE/config.yaml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: Ask a question or get help
5+
url: https://ukgovernmentdigital.slack.com/archives/C1ZM2T0SG
6+
about: Uk Government digital slack channel for Technical Writers

‎.github/ISSUE_TEMPLATE/enhancement.yaml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: ✨ New or updated feature
2+
description: Suggest a new feature or improvement
3+
title: "[Enhancement]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: What should change?
10+
description: What would fix the issue? Is this something you think should behave differently, or something that you currently cannot do?
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: user-need
16+
attributes:
17+
label: User need
18+
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
19+
20+
- type: textarea
21+
id: proposal
22+
attributes:
23+
label: Proposed solution
24+
description: Optional — describe how you think this could work or a solution you have in mind
25+

‎.github/pull_request_template.md‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
1-
<!--
2-
## Please fill in the sections below
1+
## Proposed changes
32

4-
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.
5-
-->
3+
### What changed
64

7-
## What’s changed
5+
Describe the changes made and the impact the changes have.
86

9-
<!-- What are you trying to do? Is this something that changes how the Tech Docs Template behaves, or is it fixing a bug? -->
7+
## Related issue or tracking reference
108

9+
You should have an open GitHub issue that this PR will fix.
1110

12-
## Identifying a user need
11+
- Fixes #
12+
- Relates to #
1313

14-
<!-- Do you have evidence that this meets the needs of users? Let us know about any user research or testing you’ve done. -->
14+
> If there is no issue, please open one or please explain why one is not needed (for example small maintenance change, routine dependency update).
15+
16+
## Screenshots or examples (if relevant)
17+
18+
Include screenshots, logs, or rendered output if this change affects layout or behaviour.
19+
20+
## Checklist
21+
22+
Before you request approval you should confirm that:
23+
24+
- [ ] the pull request has a clear title with a short description about the update in the documentation
25+
- [ ] GitHub actions all pass
26+
- [ ] you have tested the changes with a fresh build against the latest version of the `tech-docs-gem`
27+
- [ ] you have linked this PR to an issue (or explained why none exists)
28+
- [ ] you have updated documentation if needed

‎.github/workflows/dependency-review.yaml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: 'Dependency Review'
2+
on: [pull_request]
3+
4+
permissions:
5+
contents: read
6+
7+
jobs:
8+
dependency-review:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: 'Checkout Repository'
12+
uses: actions/checkout@v6
13+
- name: 'Dependency Review'
14+
uses: actions/dependency-review-action@v4
15+
with:
16+
fail-on-severity: high
17+
show-patched-versions: true

0 commit comments

Comments
 (0)