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
Start with an overview or a brief description of what the project is about and what it does. For example -
5
+
NHS Notify - for the NHS Notify web site, onboarding guidance, and customer support, please visit the [NHS Service Catalogue](https://digital.nhs.uk/services/nhs-notify).
7
6
8
-
Welcome to our repository template designed to streamline your project setup! This robust template provides a reliable starting point for your new projects, covering an essential tech stack and encouraging best practices in documenting.
7
+
## Who/what is this repository is for?
9
8
10
-
This repository template aims to foster a user-friendly development environment by ensuring that every included file is concise and adequately self-documented. By adhering to this standard, we can promote increased clarity and maintainability throughout your project's lifecycle. Bundled within this template are resources that pave the way for seamless repository creation. Currently supported technologies are:
9
+
- NHS Developers working on NHS Notify
10
+
- Those who are interested in NHS Notify architecture and how it is developed.
11
11
12
-
- Terraform
13
-
- Docker
12
+
## Who/what is this repository not for?
14
13
15
-
Make use of this repository template to expedite your project setup and enhance your productivity right from the get-go. Enjoy the advantage of having a well-structured, self-documented project that reduces overhead and increases focus on what truly matters - coding!
14
+
- Customer Support
15
+
- Supplier Support
16
16
17
17
## Table of Contents
18
18
19
19
-[NHS Notify](#nhs-notify)
20
+
-[Who/what is this repository is for?](#whowhat-is-this-repository-is-for)
21
+
-[Who/what is this repository not for?](#whowhat-is-this-repository-not-for)
20
22
-[Table of Contents](#table-of-contents)
21
23
-[Documentation](#documentation)
22
24
-[Setup](#setup)
23
25
-[Prerequisites](#prerequisites)
24
26
-[Configuration](#configuration)
25
27
-[Usage](#usage)
26
-
-[Testing](#testing)
27
28
-[Design](#design)
28
29
-[Diagrams](#diagrams)
29
30
-[Modularity](#modularity)
@@ -38,51 +39,20 @@ Make use of this repository template to expedite your project setup and enhance
38
39
39
40
## Setup
40
41
41
-
By including preferably a one-liner or if necessary a set of clear CLI instructions we improve user experience. This should be a frictionless installation process that works on various operating systems (macOS, Linux, Windows WSL) and handles all the dependencies.
The following software packages, or their equivalents, are expected to be installed and configured:
53
-
54
-
-[Docker](https://www.docker.com/) container runtime or a compatible tool, e.g. [Podman](https://podman.io/),
55
-
-[asdf](https://asdf-vm.com/) version manager,
56
-
-[GNU make](https://www.gnu.org/software/make/) 3.82 or later,
57
-
-[GNU coreutils](https://www.gnu.org/software/coreutils/) and [GNU binutils](https://www.gnu.org/software/binutils/) may be required to build dependencies like Python, which may need to be compiled during installation. For macOS users, this has been scripted and automated by the `dotfiles` project; please see this [script](https://github.com/nhs-england-tools/dotfiles/blob/main/assets/20-install-base-packages.macos.sh) for details,
58
-
-[Python](https://www.python.org/) required to run Git hooks,
59
-
-[`jq`](https://jqlang.github.io/jq/) a lightweight and flexible command-line JSON processor.
60
-
61
-
> [!NOTE]<br>
62
-
> The version of GNU make available by default on macOS is earlier than 3.82. You will need to upgrade it or certain `make` tasks will fail. On macOS, you will need [Homebrew](https://brew.sh/) installed, then to install `make`, like so:
63
-
>
64
-
> ```shell
65
-
> brew install make
66
-
>```
67
-
>
68
-
> You will then see instructions to fix your `$PATH` variable to make the newly installed version available. If you are using [dotfiles](https://github.com/nhs-england-tools/dotfiles), this is all donefor you.
69
-
70
52
### Configuration
71
53
72
-
Installation and configuration of the toolchain dependencies
73
-
74
-
```shell
75
-
make config
76
-
```
77
-
78
54
## Usage
79
55
80
-
After a successful installation, provide an informative example of how this project can be used. Additional code snippets, screenshots and demos work well in this space. You may also link to the other documentation resources, e.g. the [User Guide](./docs/user-guide.md) to demonstrate more use cases and to show more features.
81
-
82
-
### Testing
83
-
84
-
There are `make` tasks for you to configure to run your tests. Run `make test` to see how they work. You should be able to use the same entry points for local development as in your CI pipeline.
85
-
86
56
## Design
87
57
88
58
### Diagrams
@@ -100,19 +70,11 @@ Most of the projects are built with customisability and extendability in mind. A
100
70
Describe or link templates on how to raise an issue, feature request or make a contribution to the codebase. Reference the other documentation files, like
101
71
102
72
- Environment setup for contribution, i.e. `CONTRIBUTING.md`
103
-
- Coding standards, branching, linting, practices for development and testing
104
-
- Release process, versioning, changelog
105
-
- Backlog, board, roadmap, ways of working
106
-
- High-level requirements, guiding principles, decision records, etc.
107
73
108
74
## Contacts
109
75
110
-
Provide a way to contact the owners of this project. It can be a team, an individual or information on the means of getting in touch via active communication channels, e.g. opening a GitHub discussion, raising an issue, etc.
111
-
112
76
## Licence
113
77
114
-
> The [LICENCE.md](./LICENCE.md) file will need to be updated with the correct year and owner
115
-
116
78
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.
0 commit comments