|
| 1 | +# Contribution Guidelines |
| 2 | + |
| 3 | +This repository is maintained by the National Record Locator team within the Transformation Directorate of NHS England. |
| 4 | +We welcome contributions from other teams. |
| 5 | + |
| 6 | +## Raising an Issue |
| 7 | + |
| 8 | +If you raise an issue against this repository, please include as much information as possible to reproduce any bugs, |
| 9 | +or specific locations in the case of content errors. |
| 10 | + |
| 11 | +## Contributing Code |
| 12 | + |
| 13 | +To contribute code, please raise a pull request. |
| 14 | + |
| 15 | +Ideally pull requests should be fairly granular and aim to solve one problem each. It would also be helpful if they |
| 16 | +linked to an issue. If the maintainers cannot understand why a pull request was raised, it will be rejected, |
| 17 | +so please explain why the changes need to be made (unless it is self-evident) or reference the issue they solve. |
| 18 | + |
| 19 | +Code owners are notified daily about any pending pull requests via automated tools. If your pull request is not |
| 20 | +yet ready for review, please consider keeping it marked as a Draft. |
| 21 | + |
| 22 | +### Naming and committing conventions |
| 23 | + |
| 24 | +Branch names should be of the format: |
| 25 | + |
| 26 | +`feature/[Shortcode]-[Jira-ref]-short-issue-description` |
| 27 | +e.g. |
| 28 | +`feature/shco1-NRL-123-contribution-guidelines` |
| 29 | + |
| 30 | +Multiple branches are permitted for the same ticket. |
| 31 | + |
| 32 | +Please include the Jira reference in your commit messages. |
| 33 | + |
| 34 | +Your pull request title should include the ticket reference and a short summary of the change; |
| 35 | +these are used to compile the release notes for each iteration. |
| 36 | + |
| 37 | +## Specification Changes |
| 38 | + |
| 39 | +If your submission changes the behaviour of the NRL, please consider whether the user-facing documentation |
| 40 | +should be updated at the same time to reflect these changes. There are two related repositories containing |
| 41 | +the specifications [for Producers](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v3/producer) |
| 42 | +and [Consumers](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v3/consumer) |
| 43 | +of NRL pointers, respectively: |
| 44 | + |
| 45 | +- [NRL Producer API](https://github.com/NHSDigital/nrl-producer-api) |
| 46 | +- [NRL Consumer API](https://github.com/NHSDigital/nrl-consumer-api) |
0 commit comments