From 3d52c93cdac886dc9245457a34edc4138af040c4 Mon Sep 17 00:00:00 2001 From: katebobyn-nhs <101277966+katebobyn-nhs@users.noreply.github.com> Date: Sun, 1 Feb 2026 22:30:49 +0000 Subject: [PATCH 1/2] Add contribution guidance --- CONTRIBUTING.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..09a4d0c43 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# Contribution Guidelines + +This repository is maintained by the National Record Locator team within the Transformation Directorate of NHS England. +We welcome contributions from other teams. + +## Raising an Issue + +If you raise an issue against this repository, please include as much information as possible to reproduce any bugs, +or specific locations in the case of content errors. + +## Contributing Code + +To contribute code, please raise a pull request. + +Ideally pull requests should be fairly granular and aim to solve one problem each. It would also be helpful if they +linked to an issue. If the maintainers cannot understand why a pull request was raised, it will be rejected, +so please explain why the changes need to be made (unless it is self-evident) or reference the issue they solve. + +Code owners are notified daily about any pending pull requests via automated tools. If your pull request is not +yet ready for review, please consider keeping it marked as a Draft. + +### Naming and committing conventions + +Branch names should be of the format: + +`feature/[Shortcode]-[Jira-ref]-short-issue-description` +e.g. +`feature/shco1-NRL-123-contribution-guidelines` + +Multiple branches are permitted for the same ticket. + +Please include the Jira reference in your commit messages. + +Your pull request title should include the ticket reference and a short summary of the change; +these are used to compile the release notes for each iteration. + +## Specification Changes + +If your submission changes the behaviour of the NRL, please consider whether the user-facing documentation +should be updated at the same time to reflect these changes. There are two related repositories containing +the specifications [for Producers](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v3/producer) +and [Consumers](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v3/consumer) +of NRL pointers, respectively: +- [NRL Producer API](https://github.com/NHSDigital/nrl-producer-api) +- [NRL Consumer API](https://github.com/NHSDigital/nrl-consumer-api) From 6d6f7535065a02c7f79505cde5e2b99284bab5d0 Mon Sep 17 00:00:00 2001 From: Kate Bobyn Date: Mon, 2 Feb 2026 13:11:59 +0000 Subject: [PATCH 2/2] NRL-856 fix formatting of contribution guidelines --- CONTRIBUTING.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 09a4d0c43..4db824674 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Contribution Guidelines -This repository is maintained by the National Record Locator team within the Transformation Directorate of NHS England. -We welcome contributions from other teams. +This repository is maintained by the National Record Locator team within the Transformation Directorate of NHS England. +We welcome contributions from other teams. ## Raising an Issue @@ -14,10 +14,10 @@ To contribute code, please raise a pull request. Ideally pull requests should be fairly granular and aim to solve one problem each. It would also be helpful if they linked to an issue. If the maintainers cannot understand why a pull request was raised, it will be rejected, -so please explain why the changes need to be made (unless it is self-evident) or reference the issue they solve. +so please explain why the changes need to be made (unless it is self-evident) or reference the issue they solve. -Code owners are notified daily about any pending pull requests via automated tools. If your pull request is not -yet ready for review, please consider keeping it marked as a Draft. +Code owners are notified daily about any pending pull requests via automated tools. If your pull request is not +yet ready for review, please consider keeping it marked as a Draft. ### Naming and committing conventions @@ -27,19 +27,20 @@ Branch names should be of the format: e.g. `feature/shco1-NRL-123-contribution-guidelines` -Multiple branches are permitted for the same ticket. +Multiple branches are permitted for the same ticket. -Please include the Jira reference in your commit messages. +Please include the Jira reference in your commit messages. -Your pull request title should include the ticket reference and a short summary of the change; -these are used to compile the release notes for each iteration. +Your pull request title should include the ticket reference and a short summary of the change; +these are used to compile the release notes for each iteration. ## Specification Changes -If your submission changes the behaviour of the NRL, please consider whether the user-facing documentation -should be updated at the same time to reflect these changes. There are two related repositories containing -the specifications [for Producers](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v3/producer) -and [Consumers](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v3/consumer) -of NRL pointers, respectively: +If your submission changes the behaviour of the NRL, please consider whether the user-facing documentation +should be updated at the same time to reflect these changes. There are two related repositories containing +the specifications [for Producers](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v3/producer) +and [Consumers](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v3/consumer) +of NRL pointers, respectively: + - [NRL Producer API](https://github.com/NHSDigital/nrl-producer-api) - [NRL Consumer API](https://github.com/NHSDigital/nrl-consumer-api)