Skip to content

Commit d6fbcfe

Browse files
committed
feat(code): align repository to the template
1 parent faac8a7 commit d6fbcfe

40 files changed

+836
-245
lines changed

.editorconfig

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ indent_size = unset
1414
[*.py]
1515
indent_size = 4
1616

17-
[{Dockerfile,Dockerfile.*,*.Dockerfile,Dockerfile.template}]
17+
[{Dockerfile,Dockerfile.}*]
1818
indent_size = 4
1919

20-
[{Makefile,Makefile.*,*.mk,go.mod,go.sum,*.go,.gitmodules}]
20+
[{Makefile,Makefile.template,*.mk,.gitmodules}]
2121
indent_style = tab

.gitattributes

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,5 @@
22
.specify/templates/** linguist-vendored
33
scripts/config/** linguist-vendored
44
scripts/docker/** linguist-vendored
5-
scripts/githooks/** linguist-vendored
6-
scripts/reports/** linguist-vendored
5+
scripts/quality/** linguist-vendored
76
scripts/init.mk linguist-vendored
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# See:
2+
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
3+
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
4+
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms
5+
6+
name: 🔧 Support Request
7+
description: Get help using this project
8+
title: "[Support]: "
9+
labels: ["support"]
10+
body:
11+
- type: markdown
12+
attributes:
13+
value: |
14+
Thanks for taking the time to file a support request.
15+
Please fill out this form as completely as you can.
16+
- type: checkboxes
17+
id: preflight
18+
attributes:
19+
label: Existing issues
20+
description: Please search existing issues before raising a new one.
21+
options:
22+
- label: I have searched the existing issues
23+
required: true
24+
- type: input
25+
id: summary
26+
attributes:
27+
label: Summary
28+
description: A short summary of the help you need.
29+
placeholder: e.g. Unable to run make config on macOS
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: goal
34+
attributes:
35+
label: What are you trying to do?
36+
description: Describe your goal and the outcome you want.
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: tried
41+
attributes:
42+
label: What have you tried so far?
43+
description: Include commands, config changes, and references you followed.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: expected
48+
attributes:
49+
label: What did you expect to happen?
50+
description: If helpful, describe the expected result.
51+
validations:
52+
required: false
53+
- type: textarea
54+
id: actual
55+
attributes:
56+
label: What happened instead?
57+
description: Describe the result you saw, including errors or warnings.
58+
validations:
59+
required: false
60+
- type: textarea
61+
id: steps
62+
attributes:
63+
label: Steps to reproduce (if relevant)
64+
description: Provide clear steps if the issue is repeatable.
65+
placeholder: |
66+
1. ...
67+
2. ...
68+
validations:
69+
required: false
70+
- type: textarea
71+
id: environment
72+
attributes:
73+
label: Environment
74+
description: Add relevant details about your setup.
75+
value: |
76+
- OS:
77+
- Tool versions:
78+
- Runtime:
79+
render: markdown
80+
validations:
81+
required: false
82+
- type: input
83+
id: version
84+
attributes:
85+
label: Project version or commit
86+
description: If known, provide a version, tag, or commit SHA.
87+
placeholder: e.g. v1.2.3 or abc1234
88+
validations:
89+
required: false
90+
- type: textarea
91+
id: logs
92+
attributes:
93+
label: Relevant command output
94+
description: Please copy and paste relevant output. This will be formatted as code.
95+
render: shell
96+
validations:
97+
required: false
98+
- type: textarea
99+
id: context
100+
attributes:
101+
label: Additional context
102+
description: Add any other context or screenshots that might help.
103+
validations:
104+
required: false
105+
- type: checkboxes
106+
id: conduct
107+
attributes:
108+
label: Code of Conduct
109+
description: By submitting this issue, you agree to follow this project's Code of Conduct.
110+
options:
111+
- label: I agree to follow this project's Code of Conduct
112+
required: true
113+
- type: checkboxes
114+
id: sensitive
115+
attributes:
116+
label: Sensitive information
117+
description: Please do not include PII or PID, or any other sensitive data. See [data safety guidance](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public).
118+
options:
119+
- label: I confirm this request does not include PII/PID, or sensitive data
120+
required: true
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# See:
2+
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
3+
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
4+
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms
5+
6+
name: 🚀 Feature Request
7+
description: Suggest an idea for this project
8+
title: "[Feature]: "
9+
labels: ["feature request"]
10+
body:
11+
- type: markdown
12+
attributes:
13+
value: |
14+
Thanks for taking the time to file a feature request.
15+
Please fill out this form as completely as you can.
16+
- type: checkboxes
17+
id: preflight
18+
attributes:
19+
label: Existing issues
20+
description: Please search existing issues before raising a new one.
21+
options:
22+
- label: I have searched the existing issues
23+
required: true
24+
- type: input
25+
id: summary
26+
attributes:
27+
label: Summary
28+
description: A short summary of the feature you want.
29+
placeholder: e.g. Add a make target for dependency updates
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: problem
34+
attributes:
35+
label: What problem does this solve?
36+
description: Explain why this change is needed and who it helps.
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: proposal
41+
attributes:
42+
label: Proposed solution
43+
description: Describe what you would like to see built.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: alternatives
48+
attributes:
49+
label: Alternatives considered
50+
description: Describe any alternatives or workarounds you have considered.
51+
validations:
52+
required: false
53+
- type: textarea
54+
id: benefits
55+
attributes:
56+
label: Expected benefits
57+
description: Describe the impact, including users, performance, or maintainability.
58+
validations:
59+
required: false
60+
- type: textarea
61+
id: acceptance
62+
attributes:
63+
label: Acceptance criteria (if any)
64+
description: List any clear conditions for success.
65+
placeholder: |
66+
- [ ] ...
67+
- [ ] ...
68+
validations:
69+
required: false
70+
- type: textarea
71+
id: context
72+
attributes:
73+
label: Additional context
74+
description: Add any other context or screenshots that might help.
75+
validations:
76+
required: false
77+
- type: checkboxes
78+
id: conduct
79+
attributes:
80+
label: Code of Conduct
81+
description: By submitting this issue, you agree to follow this project's Code of Conduct.
82+
options:
83+
- label: I agree to follow this project's Code of Conduct
84+
required: true
85+
- type: checkboxes
86+
id: sensitive
87+
attributes:
88+
label: Sensitive information
89+
description: Please do not include PII or PID, or any other sensitive data. See [data safety guidance](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public).
90+
options:
91+
- label: I confirm this request does not include PII/PID, or sensitive data
92+
required: true
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# See:
2+
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
3+
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
4+
# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms
5+
6+
name: 🐞 Bug Report
7+
description: File a bug report
8+
title: "[Bug]: "
9+
labels: ["bug", "triage"]
10+
body:
11+
- type: markdown
12+
attributes:
13+
value: |
14+
Thanks for taking the time to file a bug report.
15+
Please fill out this form as completely as you can.
16+
- type: checkboxes
17+
id: preflight
18+
attributes:
19+
label: Existing issues
20+
description: Please search existing issues before raising a new one.
21+
options:
22+
- label: I have searched the existing issues
23+
required: true
24+
- type: input
25+
id: summary
26+
attributes:
27+
label: Summary
28+
description: A short summary of the bug.
29+
placeholder: e.g. make lint fails on macOS
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: current
34+
attributes:
35+
label: Current behaviour
36+
description: A concise description of what you are experiencing.
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: expected
41+
attributes:
42+
label: Expected behaviour
43+
description: A concise description of what you expect to happen.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: steps
48+
attributes:
49+
label: Steps to reproduce
50+
description: Steps to reproduce the behaviour.
51+
placeholder: |
52+
1. ...
53+
2. ...
54+
3. ...
55+
validations:
56+
required: false
57+
- type: textarea
58+
id: environment
59+
attributes:
60+
label: Environment
61+
description: Add relevant details about your setup.
62+
value: |
63+
- OS:
64+
- Tool versions:
65+
- Runtime:
66+
render: markdown
67+
validations:
68+
required: false
69+
- type: input
70+
id: version
71+
attributes:
72+
label: Project version or commit
73+
description: If known, provide a version, tag, or commit SHA.
74+
placeholder: e.g. v1.2.3 or abc1234
75+
validations:
76+
required: false
77+
- type: textarea
78+
id: logs
79+
attributes:
80+
label: Relevant command output
81+
description: Please copy and paste relevant output. This will be formatted as code.
82+
render: shell
83+
validations:
84+
required: false
85+
- type: textarea
86+
id: context
87+
attributes:
88+
label: Additional context
89+
description: Add any other context or screenshots that might help.
90+
validations:
91+
required: false
92+
- type: checkboxes
93+
id: conduct
94+
attributes:
95+
label: Code of Conduct
96+
description: By submitting this issue, you agree to follow this project's Code of Conduct.
97+
options:
98+
- label: I agree to follow this project's Code of Conduct
99+
required: true
100+
- type: checkboxes
101+
id: sensitive
102+
attributes:
103+
label: Sensitive information
104+
description: Please do not include PII or PID, or any other sensitive data. See [data safety guidance](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public).
105+
options:
106+
- label: I confirm this report does not include PII/PID, or sensitive data
107+
required: true

.github/actions/check-file-format/action.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ runs:
77
shell: bash
88
run: |
99
export BRANCH_NAME=origin/${{ github.event.repository.default_branch }}
10-
check=branch ./scripts/githooks/check-file-format.sh
10+
make check-file-format check=all

.github/actions/check-markdown-format/action.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ runs:
77
shell: bash
88
run: |
99
export BRANCH_NAME=origin/${{ github.event.repository.default_branch }}
10-
check=branch ./scripts/githooks/check-markdown-format.sh
10+
make check-markdown-format check=all

.github/actions/check-markdown-links/action.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ runs:
77
shell: bash
88
run: |
99
export BRANCH_NAME=origin/${{ github.event.repository.default_branch }}
10-
check=branch ./scripts/githooks/check-markdown-links.sh
10+
make check-markdown-links check=all

.github/actions/create-lines-of-code-report/action.yaml

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

.github/actions/scan-secrets/action.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ runs:
77
shell: bash
88
run: |
99
# Please do not change this `check=whole-history` setting, as new patterns may be added or history may be rewritten.
10-
check=whole-history ./scripts/githooks/scan-secrets.sh
10+
make scan-secrets check=whole-history

0 commit comments

Comments
 (0)