Skip to content

Commit 5ef6721

Browse files
committed
NPA-3901 Update Contributing Documentation
1 parent cd935f8 commit 5ef6721

File tree

2 files changed

+46
-18
lines changed

2 files changed

+46
-18
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# Contribution Guidelines
22

3-
- [Contribution Guidelines](#contribution-guidelines)
4-
- [Raising an Issue](#raising-an-issue)
5-
- [Contributing code](#contributing-code)
6-
- [Merge responsibility](#merge-responsibility)
7-
- [Branch naming](#branch-naming)
8-
- [Commit messages](#commit-messages)
3+
- [Contribution Guidelines](#contribution-guidelines)
4+
- [Raising an Issue](#raising-an-issue)
5+
- [Contributing code](#contributing-code)
6+
- [Merge responsibility](#merge-responsibility)
7+
- [Branch naming](#branch-naming)
8+
- [Developers within the NHS](#developers-within-the-nhs)
9+
- [Developers outside of the NHS](#developers-outside-of-the-nhs)
10+
- [Commit messages](#commit-messages)
11+
- [Developers within the NHS](#developers-within-the-nhs-1)
12+
- [Developers outside of the NHS](#developers-outside-of-the-nhs-1)
913

1014
## Raising an Issue
1115

@@ -22,20 +26,44 @@ so please explain why the changes need to be made (unless it is self-evident).
2226

2327
### Merge responsibility
2428

25-
- It is the responsibility of the reviewer to merge branches they have approved.
26-
- It is the responsibility of the author of the merge to ensure their merge is in a mergeable state.
27-
- It is the responsibility of the maintainers to ensure the merge process is unambiguous and automated where possible.
29+
- It is the responsibility of the reviewer to merge branches they have approved.
30+
- It is the responsibility of the author of the merge to ensure their merge is in a mergeable state.
31+
- It is the responsibility of the maintainers to ensure the merge process is unambiguous and automated where possible.
2832

2933
### Branch naming
3034

35+
#### Developers within the NHS
36+
3137
Branch names should be of the format:
3238

33-
`apm-nnn-short-issue-description`
39+
`NPA-nnnn_short_issue_description`
40+
e.g. `NPA-1234_update_readme`
41+
42+
Multiple branches are permitted for the same ticket.
43+
44+
#### Developers outside of the NHS
45+
46+
Branch names should be of the format:
47+
48+
`short_issue_description`
3449

3550
Multiple branches are permitted for the same ticket.
3651

3752
### Commit messages
3853

54+
#### Developers within the NHS
55+
56+
Commit messages should be formatted as follows:
57+
58+
```
59+
APM-NNN Summary of changes
60+
61+
Longer description of changes if explaining rationale is necessary,
62+
limited to 80 columns and spanning as many lines as you need.
63+
```
64+
65+
#### Developers outside of the NHS
66+
3967
Commit messages should be formatted as follows:
4068

4169
```

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# validated-relationships-service-api
22

3-
This is a RESTful FHIR API for the [Validated Relationship Service API](https://digital.nhs.uk/developer/api-catalogue/validated-relationship-service).
3+
This is a RESTful FHIR API for the [Validated Relationship Service](https://digital.nhs.uk/developer/api-catalogue/validated-relationship-service).
44

55
Consumers of the API will find developer documentation on the [NHS Digital Developer Hub](https://digital.nhs.uk/developer/api-catalogue/validated-relationship-service).
66

77
This repository does _not_ include the Validated Relationship Service FHIR API back-end. That is part of 'Proxy Validated Relationship Service' repository which is not currently open source.
88

99
## Table of Contents
1010

11-
- [validated-relationships-service-api](#validated-relationships-service-api)
12-
- [Table of Contents](#table-of-contents)
13-
- [Repository Structure](#repository-structure)
14-
- [Contributing](#contributing)
15-
- [Development \& Testing](#development--testing)
16-
- [Licensing](#licensing)
11+
- [validated-relationships-service-api](#validated-relationships-service-api)
12+
- [Table of Contents](#table-of-contents)
13+
- [Repository Structure](#repository-structure)
14+
- [Contributing](#contributing)
15+
- [Development \& Testing](#development--testing)
16+
- [Licensing](#licensing)
1717

1818
## Repository Structure
1919

@@ -30,7 +30,7 @@ Contributions to this project are welcome from anyone, providing that they confo
3030

3131
## Development & Testing
3232

33-
All development commands and documentation can be found in [DEVELOPMENT_GUIDE.md](./DEVELOPMENT_GUIDE.md).
33+
Development documentation can be found in [DEVELOPMENT_GUIDE.md](./DEVELOPMENT_GUIDE.md).
3434

3535
### Licensing
3636

0 commit comments

Comments
 (0)