Skip to content

Commit bf69df4

Browse files
authored
Update diagrams section and add Mermaids example (nhs-england-tools#165)
<!-- markdownlint-disable-next-line first-line-heading --> ## Description Small update to the README with suggestions for diagram options that keep the source under version control. I.e. `drawio` which is already used in the examples, but also `mermaids`. Also provide a basic `mermaids` example. ## Context Updates guidance on diagram tooling. ## Type of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. --> - [ ] Refactoring (non-breaking change) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would change existing functionality) - [ ] Bug fix (non-breaking change which fixes an issue) ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [ ] I am familiar with the [contributing guidelines](../docs/CONTRIBUTING.md) - [ ] I have followed the code style of the project - [ ] I have added tests to cover my changes - [ ] I have updated the documentation accordingly - [ ] This PR is a result of pair or mob programming --- ## Sensitive Information Declaration To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including [PII (Personal Identifiable Information) / PID (Personal Identifiable Data)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter. - [ ] I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.
1 parent 0ed3c55 commit bf69df4

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,18 @@ The [C4 model](https://c4model.com/) is a simple and intuitive way to create sof
9191

9292
![Repository Template](./docs/diagrams/Repository_Template_GitHub_Generic.png)
9393

94+
The source for diagrams should be in Git for change control and review purposes. Recommendations are [draw.io](https://app.diagrams.net/) (example above in [docs](.docs/diagrams/) folder) and [Mermaids](https://github.com/mermaid-js/mermaid). Here is an example Mermaids sequence diagram:
95+
96+
```mermaid
97+
sequenceDiagram
98+
User->>+Service: GET /users?params=...
99+
Service->>Service: auth request
100+
Service->>Database: get all users
101+
Database-->>Service: list of users
102+
Service->>Service: filter users
103+
Service-->>-User: list[User]
104+
```
105+
94106
### Modularity
95107

96108
Most of the projects are built with customisability and extendability in mind. At a minimum, this can be achieved by implementing service level configuration options and settings. The intention of this section is to show how this can be used. If the system processes data, you could mention here for example how the input is prepared for testing - anonymised, synthetic or live data.

0 commit comments

Comments
 (0)