Skip to content

Commit 1c16d14

Browse files
authored
Initial commit
0 parents  commit 1c16d14

File tree

216 files changed

+21918
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

216 files changed

+21918
-0
lines changed

.devcontainer/devcontainer.json

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
{
2+
"customizations": {
3+
"codespaces": {
4+
"openFiles": [
5+
"README.md",
6+
".github/SECURITY.md",
7+
"docs/index.md"
8+
]
9+
},
10+
"vscode": {
11+
"extensions": [
12+
"alefragnani.bookmarks",
13+
"AmazonWebServices.aws-toolkit-vscode",
14+
"chdsbd.github-code-owners",
15+
"davidanson.vscode-markdownlint",
16+
"dbaeumer.vscode-eslint",
17+
"donjayamanne.githistory",
18+
"editorconfig.editorconfig",
19+
"esbenp.prettier-vscode",
20+
"fvclaus.sort-json-array",
21+
"github.codespaces",
22+
"github.github-vscode-theme",
23+
"github.remotehub",
24+
"github.vscode-github-actions",
25+
"github.vscode-pull-request-github",
26+
"hediet.vscode-drawio",
27+
"johnpapa.vscode-peacock",
28+
"joshx.workspace-terminals",
29+
"maattdd.gitless",
30+
"mhutchie.git-graph",
31+
"ms-azuretools.vscode-docker",
32+
"ms-vscode-remote.remote-containers",
33+
"ms-vscode-remote.remote-wsl",
34+
"ms-vscode.hexeditor",
35+
"ms-vscode.live-server",
36+
"ms-vsliveshare.vsliveshare",
37+
"redhat.vscode-xml",
38+
"streetsidesoftware.code-spell-checker-british-english",
39+
"takumii.markdowntable",
40+
"tamasfe.even-better-toml",
41+
"tomoki1207.pdf",
42+
"vscode-icons-team.vscode-icons",
43+
"vstirbu.vscode-mermaid-preview",
44+
"wayou.vscode-todo-highlight",
45+
"yzane.markdown-pdf",
46+
"yzhang.dictionary-completion",
47+
"yzhang.markdown-all-in-one",
48+
"zoma.vscode-auto-open-workspace"
49+
],
50+
"settings": {
51+
"[makefile]": {
52+
"editor.detectIndentation": false,
53+
"editor.insertSpaces": false
54+
},
55+
"autoOpenWorkspace.enableAutoOpenIfSingleWorkspace": true,
56+
"editor.formatOnSave": true,
57+
"extensions.ignoreRecommendations": true,
58+
"files.insertFinalNewline": true
59+
}
60+
}
61+
},
62+
"forwardPorts": [
63+
4000
64+
],
65+
"image": "ghcr.io/nhsdigital/nhs-notify-template-repository:latest",
66+
"name": "Jekyll",
67+
"runArgs": [
68+
"--platform=linux/amd64"
69+
]
70+
}

.editorconfig

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
indent_size = 2
7+
indent_style = space
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
11+
[*.md]
12+
indent_size = unset
13+
14+
[*.py]
15+
indent_size = 4
16+
17+
[{Dockerfile,Dockerfile.}*]
18+
indent_size = 4
19+
20+
[{Makefile,*.mk,go.mod,go.sum,*.go,.gitmodules}]
21+
indent_style = tab
22+
23+
# Ignore paths
24+
[Gemfile.lock]
25+
charset = unset
26+
end_of_line = unset
27+
insert_final_newline = unset
28+
trim_trailing_whitespace = unset
29+
indent_style = unset
30+
indent_size = unset
31+
generated_code = true

.gitattributes

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
scripts/docker/** linguist-vendored
2+
scripts/githooks/** linguist-vendored
3+
scripts/reports/** linguist-vendored
4+
scripts/terraform/** linguist-vendored
5+
scripts/tests/test.mk linguist-vendored
6+
scripts/init.mk linguist-vendored
7+
scripts/shellscript-linter.sh linguist-vendored

.github/CODEOWNERS

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# NHS Notify Code Owners
2+
3+
# Notify default owners
4+
* @NHSDigital/nhs-notify-repository-template
5+
6+
/.github/ @NHSDigital/nhs-notify-repository-template-admins
7+
*.code-workspace @NHSDigital/nhs-notify-repository-template-admins
8+
/infrastructure/terraform/ @NHSDigital/nhs-notify-platform
9+
10+
# Codeowners must be final check
11+
/.github/CODEOWNERS @NHSDigital/nhs-notify-code-owners
12+
/CODEOWNERS @NHSDigital/nhs-notify-code-owners
13+
14+
15+
# Each NHS Notify repository should have clear code owners set.
16+
# Do not use GitHub team names, instead use the GitHub usernames
17+
# of the people who are responsible for the code maintenance.
18+
19+
# This is a comment.
20+
# Each line is a file pattern followed by one or more owners.
21+
22+
# These owners will be the default owners for everything in
23+
# the repo. Unless a later match takes precedence,
24+
# @global-owner1 and @global-owner2 will be requested for
25+
# review when someone opens a pull request.
26+
# * @global-owner1 @global-owner2
27+
28+
# Order is important; the last matching pattern takes the most
29+
# precedence. When someone opens a pull request that only
30+
# modifies JS files, only @js-owner and not the global
31+
# owner(s) will be requested for a review.
32+
# *.js @js-owner #This is an inline comment.
33+
34+
# You can also use email addresses if you prefer. They'll be
35+
# used to look up users just like we do for commit author
36+
# emails.
37+
38+
39+
# Teams can be specified as code owners as well. Teams should
40+
# be identified in the format @org/team-name. Teams must have
41+
# explicit write access to the repository. In this example,
42+
# the octocats team in the octo-org organization owns all .txt files.
43+
# *.txt @octo-org/octocats
44+
45+
# In this example, @doctocat owns any files in the build/logs
46+
# directory at the root of the repository and any of its
47+
# subdirectories.
48+
# /build/logs/ @doctocat
49+
50+
# The `docs/*` pattern will match files like
51+
# `docs/getting-started.md` but not further nested files like
52+
# `docs/build-app/troubleshooting.md`.
53+
54+
55+
# In this example, @octocat owns any file in an apps directory
56+
# anywhere in your repository.
57+
# apps/ @octocat
58+
59+
# In this example, @doctocat owns any file in the `/docs`
60+
# directory in the root of your repository and any of its
61+
# subdirectories.
62+
# /docs/ @doctocat
63+
64+
# In this example, any change inside the `/scripts` directory
65+
# will require approval from @doctocat or @octocat.
66+
# /scripts/ @doctocat @octocat
67+
68+
# In this example, @octocat owns any file in a `/logs` directory such as
69+
# `/build/logs`, `/scripts/logs`, and `/deeply/nested/logs`. Any changes
70+
# in a `/logs` directory will require approval from @octocat.
71+
# **/logs @octocat
72+
73+
# In this example, @octocat owns any file in the `/apps`
74+
# directory in the root of your repository except for the `/apps/github`
75+
# subdirectory, as its owners are left empty.
76+
# /apps/ @octocat
77+
# /apps/github
78+
79+
# In this example, @octocat owns any file in the `/apps`
80+
# directory in the root of your repository except for the `/apps/github`
81+
# subdirectory, as this subdirectory has its own owner @doctocat
82+
# /apps/ @octocat
83+
# /apps/github @doctocat
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
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
8+
labels: ["support"]
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Thanks for taking the time to file a support request. Please fill out this form as completely as possible.
14+
- type: textarea
15+
attributes:
16+
label: What exactly are you trying to do?
17+
description: Describe in as much detail as possible.
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: What have you tried so far?
23+
description: Describe what you have tried so far.
24+
validations:
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: Output of any commands you have tried
29+
description: Please copy and paste any relevant output. This will be automatically formatted into codeblock.
30+
render: Shell
31+
validations:
32+
required: false
33+
- type: textarea
34+
attributes:
35+
label: Additional context
36+
description: Add any other context about the problem here.
37+
validations:
38+
required: false
39+
- type: checkboxes
40+
attributes:
41+
label: Code of Conduct
42+
description: By submitting this issue you agree to follow our [Code of Conduct](../../docs/CODE_OF_CONDUCT.md)
43+
options:
44+
- label: I agree to follow this project's Code of Conduct
45+
required: true
46+
- type: checkboxes
47+
attributes:
48+
label: Sensitive Information Declaration
49+
description: To ensure the utmost confidentiality and protect your privacy, we kindly ask you to NOT including [PII (Personal Identifiable Information) / PID (Personal Identifiable Data)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public) or any other sensitive data in this form. We appreciate your cooperation in maintaining the security of your information.
50+
options:
51+
- label: I confirm that neither PII/PID nor sensitive data are included in this form
52+
required: true
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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+
labels: ["feature request"]
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Thanks for taking the time to file a feature request. Please fill out this form as completely as possible.
14+
- type: textarea
15+
attributes:
16+
label: What is the problem this feature will solve?
17+
description: Tell us why this change is needed or helpful and what problems it may help solve.
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: What is the feature that you are proposing to solve the problem?
23+
description: Provide detailed information for what we should add.
24+
validations:
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: What alternatives have you considered?
29+
- type: checkboxes
30+
attributes:
31+
label: Code of Conduct
32+
description: By submitting this issue you agree to follow our [Code of Conduct](../../docs/CODE_OF_CONDUCT.md)
33+
options:
34+
- label: I agree to follow this project's Code of Conduct
35+
required: true
36+
- type: checkboxes
37+
attributes:
38+
label: Sensitive Information Declaration
39+
description: To ensure the utmost confidentiality and protect your privacy, we kindly ask you to NOT including [PII (Personal Identifiable Information) / PID (Personal Identifiable Data)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public) or any other sensitive data in this form. We appreciate your cooperation in maintaining the security of your information.
40+
options:
41+
- label: I confirm that neither PII/PID nor sensitive data are included in this form
42+
required: true
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
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+
labels: ["bug", "triage"]
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Thanks for taking the time to file a bug report. Please fill out this form as completely as possible.
14+
- type: checkboxes
15+
attributes:
16+
label: Is there an existing issue for this?
17+
description: Please, search the Issues to see if an issue already exists for the bug you have encountered.
18+
options:
19+
- label: I have searched the existing Issues
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Current Behavior
24+
description: A concise description of what you are experiencing.
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: Expected Behavior
30+
description: A concise description of what you expect to happen.
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: Steps To Reproduce
36+
description: Steps to reproduce the behavior
37+
placeholder: |
38+
1. In this environment...
39+
2. With this config...
40+
3. Run `...`
41+
validations:
42+
required: false
43+
- type: textarea
44+
attributes:
45+
label: Output
46+
description: Please copy and paste any relevant output. This will be automatically formatted into codeblock.
47+
render: Shell
48+
validations:
49+
required: false
50+
- type: checkboxes
51+
attributes:
52+
label: Code of Conduct
53+
description: By submitting this issue you agree to follow our [Code of Conduct](../../docs/CODE_OF_CONDUCT.md)
54+
options:
55+
- label: I agree to follow this project's Code of Conduct
56+
required: true
57+
- type: checkboxes
58+
attributes:
59+
label: Sensitive Information Declaration
60+
description: To ensure the utmost confidentiality and protect your privacy, we kindly ask you to NOT including [PII (Personal Identifiable Information) / PID (Personal Identifiable Data)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public) or any other sensitive data in this form. We appreciate your cooperation in maintaining the security of your information.
61+
options:
62+
- label: I confirm that neither PII/PID nor sensitive data are included in this form
63+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!-- markdownlint-disable-next-line first-line-heading -->
2+
## Description
3+
4+
<!-- Describe your changes in detail. -->
5+
6+
## Context
7+
8+
<!-- Why is this change required? What problem does it solve? -->
9+
10+
## Type of changes
11+
12+
<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->
13+
14+
- [ ] Refactoring (non-breaking change)
15+
- [ ] New feature (non-breaking change which adds functionality)
16+
- [ ] Breaking change (fix or feature that would change existing functionality)
17+
- [ ] Bug fix (non-breaking change which fixes an issue)
18+
19+
## Checklist
20+
21+
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
22+
23+
- [ ] I am familiar with the [contributing guidelines](../docs/CONTRIBUTING.md)
24+
- [ ] I have followed the code style of the project
25+
- [ ] I have added tests to cover my changes
26+
- [ ] I have updated the documentation accordingly
27+
- [ ] This PR is a result of pair or mob programming
28+
29+
---
30+
31+
## Sensitive Information Declaration
32+
33+
To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including [PII (Personal Identifiable Information) / PID (Personal Identifiable Data)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.
34+
35+
- [ ] I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

0 commit comments

Comments
 (0)