Skip to content

Commit eeb15b1

Browse files
Rossbugginsnhs/2025 10/23/copilot instructions 001 (#83)
* hook excludes. * hook excludes. * copilot instructions.
1 parent 839038e commit eeb15b1

File tree

6 files changed

+39
-1
lines changed

6 files changed

+39
-1
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"containerEnv": {
3+
"GITHUBMONITOR": "false",
4+
"MAKECONFIG": "false",
5+
"SHOWWELCOME": "true",
6+
"UPDATEFROMTEMPLATE": "false"
7+
},
8+
"image": "ghcr.io/nhsdigital/nhs-notify-devcontainer-loaded:1.0.5",
9+
"name": "Notify Loaded Dev Container 1.0.5",
10+
"postCreateCommand": "echo My own container created",
11+
"postStartCommand": "echo My own container started"
12+
}

.github/copilot-instructions.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# NHS Notify Digital Letters
2+
3+
Our core programming language is typescript, but also Python.
4+
5+
Our docs are in [.docs](./docs) and are built with jekyll.
6+
7+
This repository is for handling pre rendered letters, handling them for print and also making available for digital viewing. If viewed digitally, then they won't be printed.
8+
9+
This is just one sub domain of the whole of NHS Notify. Inside of this subdomain, there are a number of services, each with a number of microservices. The service could be a bounded context with separate deployability.
10+
11+
Services communicate in an event driven manner, using cloud events. Digital letters has its own Event Bridge, and any events to share with the wider NHS Notify system are forwarded to the core Event Bridge.
12+
13+
You can build docs with `make build` in [.docs](./docs), you will need to `make install` first. This will output to [.docs/_site](./docs/_site). Once this is built you can find out about our architecture at [./docs/site/architecture/c4/index.html](./docs/site/architecture/c4/index.html). It is event driven, events can all be found at [./docs/_site/events.html](./docs/_site/events.html)
14+
15+
All of our events will have their schemas stored in [./schemas/events](./schemas/events). These schemas are used for validation and code generation. The schemas are written in yaml and follow the json schema spec. You can find out more about json schema at [https://json-schema.org/](https://json-schema.org/).
16+
17+
For each event, there will be a schema for the envelope (this is cloud events, and will reference the default NHS Notify cloudevent profile schema). And there will also be a schema for the data payload. The data payload schema will be referenced in the envelope schema.

project.code-workspace

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,11 @@
106106
"editor.defaultFormatter": "esbenp.prettier-vscode"
107107
},
108108
"window.title": "${separator}${activeRepositoryName}${separator}${activeRepositoryBranchName}${separator}[${remoteName}]",
109-
"window.titleSeparator": " : "
109+
"window.titleSeparator": " : ",
110+
"chat.instructionsFilesLocations": {
111+
".github": true,
112+
".github/instructions": true
113+
}
110114
},
111115
"extensions": {
112116
"recommendations": [

scripts/config/vale/styles/config/vocabularies/words/accept.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[A-Z]+s
22
Bitwarden
33
bot
4+
cloudevent
45
Cognito
56
Cyber
67
Dependabot
@@ -14,16 +15,19 @@ Git[Hh]ub
1415
Gitleaks
1516
Grype
1617
idempotence
18+
jekyll
1719
Jira
1820
Makefile
1921
OAuth
2022
Octokit
2123
onboarding
2224
Podman
25+
pre
2326
Python
2427
rawContent
2528
sed
2629
Syft
2730
Terraform
2831
toolchain
2932
Trufflehog
33+
yaml

scripts/githooks/check-todos.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ EXCLUDED_DIRS=(
4040
".venv/"
4141
"docs/"
4242
"node_modules/"
43+
".devcontainer/"
4344
)
4445

4546

0 commit comments

Comments
 (0)