You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Welcome to the Orphaned Record Continuity contributors guide
2
+
3
+
Thank you for your interest in improving the codebase.
4
+
5
+
In this guide you will get an overview of the contribution workflow from creating a PR, reviewing, and merging the PR.
6
+
7
+
The codebase covers:
8
+
9
+
- The [Orphaned Record Continuity service](https://digital.nhs.uk/services/orphaned-record-continuity).
10
+
11
+
To raise an issue, please contact one of the [CODEOWNERS](.github/CODEOWNERS) directly, or raise a PR.
12
+
13
+
If you're new to GitHub and/or Markdown, GitHub's own [contributor's guide](https://github.com/github/docs/blob/main/.github/CONTRIBUTING.md) provides good signposting on these topics.
14
+
15
+
## Pull requests and merging
16
+
17
+
You can't push to the main branch. Therefore, for all changes you will need to create a new branch, and then a pull request to merge said branch into `main`. The [CODEOWNERS](.github/CODEOWNERS) will be nominated as reviewers of your PR by default, but feel free to add other people as well if you think they will have valuable input.
18
+
19
+
## Contributing guidelines and etiquette
20
+
21
+
- Preview your Markdown code to make sure the format is not broken.
22
+
- Check grammar, spelling and punctuation - no-one wants to look pedantic by requesting changes due to typos or inconsistent grammar/syntax, but it's only fair to keep this tidy.
23
+
- The codebase is open to the world. This has a few implications:
24
+
- Nothing in it should be confidential, private to NHSE or include any personal data.
25
+
- All links should be public.
26
+
- Consider comments and README.md text: comments in open source repos such as this are not official communications and don't go through the normal approval process for public communication. They can however still be interpreted as official communication, even if not intended as such.
27
+
- Use [inclusive language](https://github.com/NHSDigital/software-engineering-quality-framework/blob/main/inclusive-language.md): avoid terms which cause hurt and offence, including if they have historically been considered industry-standard terms.
Copy file name to clipboardExpand all lines: services/gp2gp-messenger/README.md
+23-22Lines changed: 23 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,15 +3,15 @@
3
3
This is an implementation of a component to handle the sending of the GP2GP message set used to transfer a patient's Electronic Health Record between GP Practices.
4
4
It uses the GP2GP message format to transfer orphaned and stranded records out of a secure NHS repository.
5
5
6
-
This component will communicate with the Message Handler Service (MHS) [GitHub nhsconnect/integration-adaptors](https://github.com/nhsconnect/integration-adaptors) and other components being developed by the Orphaned and Stranded Record programme.
6
+
This component will communicate with the Message Handler Service (MHS) using the [NIA MHS Adaptor](https://github.com/NHSDigital/integration-adaptor-mhs) and other components being developed by the Orphaned Record Continuity programme.
7
7
8
8
The initial version will send health records that are encoded in the HL7 format. A subsequent enhancement will be access to the components of the Health Record so that other services can use this component to send and receive Health Records with the need to implement the encoding and fragmentation strategies of the [GP2GP v2.2a](https://data.developer.nhs.uk/dms/mim/6.3.01/Domains/GP2GP/Document%20files/GP2GP%20IM.htm) message specification.
9
9
10
10
## Prerequisites
11
11
12
12
-[Node](https://nodejs.org/en/download/package-manager/#nvm) - version 14.x
13
13
-[Docker](https://docs.docker.com/install/)
14
-
14
+
15
15
### AWS helpers
16
16
17
17
This repository imports shared AWS helpers from [prm-deductions-support-infra](https://github.com/nhsconnect/prm-deductions-support-infra/).
@@ -20,22 +20,26 @@ They can be found `utils` directory after running any task from `tasks` file.
20
20
## Set up
21
21
22
22
If you would like to run the app locally, you need to:
23
+
23
24
1. Run `npm install` to install all node dependencies as per `package.json`.
24
-
2. Set up the env variables and/or copy them into your IDE configurations (`Run -> Edit Configurations ->Environment Variables` in IntelliJ):
Ensure you have VPN connection set up to both `dev` and `test` environments ([see this Confluence page](https://gpitbjss.atlassian.net/wiki/spaces/TW/pages/1832779966/VPN+for+Deductions+Services)).
80
81
81
82
## Access to AWS from CLI
82
83
@@ -89,4 +90,4 @@ As a note, this set-up is based on the README of assume-role [tool](https://gith
89
90
90
91
## Assume role with elevated permissions
91
92
92
-
In order to get sufficient access to work with terraform or AWS CLI, please export secrets from the AWS Access Portal for the environment you are using
93
+
In order to get sufficient access to work with terraform or AWS CLI, please export secrets from the AWS Access Portal for the environment you are using
0 commit comments