From 879e30e3cd70eabd566b9d716e7232bdcd476991 Mon Sep 17 00:00:00 2001 From: Ross Buggins Date: Thu, 16 May 2024 12:55:37 +0100 Subject: [PATCH 1/2] Update home page. --- .github/ISSUE_TEMPLATE/1_not_in_use.yaml | 13 ++++ .github/ISSUE_TEMPLATE/1_support_request.yaml | 52 --------------- .github/ISSUE_TEMPLATE/2_feature_request.yaml | 42 ------------ .github/ISSUE_TEMPLATE/3_bug_report.yaml | 63 ------------------ .vscode/settings.json | 5 +- CONTRIBUTING.md | 5 ++ README.md | 64 ++++--------------- 7 files changed, 35 insertions(+), 209 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1_not_in_use.yaml delete mode 100644 .github/ISSUE_TEMPLATE/1_support_request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/2_feature_request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/3_bug_report.yaml create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/1_not_in_use.yaml b/.github/ISSUE_TEMPLATE/1_not_in_use.yaml new file mode 100644 index 0000000..be97aeb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_not_in_use.yaml @@ -0,0 +1,13 @@ +# See: +# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository +# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms +# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms + +name: 🔧 Not In Use +description: Not currently in use +labels: ["blackhole"] +body: + - type: markdown + attributes: + value: | + Currently these are not monitored and will goto a blackhole. diff --git a/.github/ISSUE_TEMPLATE/1_support_request.yaml b/.github/ISSUE_TEMPLATE/1_support_request.yaml deleted file mode 100644 index eb24401..0000000 --- a/.github/ISSUE_TEMPLATE/1_support_request.yaml +++ /dev/null @@ -1,52 +0,0 @@ -# See: -# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository -# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms -# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms - -name: 🔧 Support Request -description: Get help -labels: ["support"] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to file a support request. Please fill out this form as completely as possible. - - type: textarea - attributes: - label: What exactly are you trying to do? - description: Describe in as much detail as possible. - validations: - required: true - - type: textarea - attributes: - label: What have you tried so far? - description: Describe what you have tried so far. - validations: - required: true - - type: textarea - attributes: - label: Output of any commands you have tried - description: Please copy and paste any relevant output. This will be automatically formatted into codeblock. - render: Shell - validations: - required: false - - type: textarea - attributes: - label: Additional context - description: Add any other context about the problem here. - validations: - required: false - - type: checkboxes - attributes: - label: Code of Conduct - description: By submitting this issue you agree to follow our [Code of Conduct](../../docs/CODE_OF_CONDUCT.md) - options: - - label: I agree to follow this project's Code of Conduct - required: true - - type: checkboxes - attributes: - label: Sensitive Information Declaration - description: To ensure the utmost confidentiality and protect your 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 form. We appreciate your cooperation in maintaining the security of your information. - options: - - label: I confirm that neither PII/PID nor sensitive data are included in this form - required: true diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.yaml b/.github/ISSUE_TEMPLATE/2_feature_request.yaml deleted file mode 100644 index 705d083..0000000 --- a/.github/ISSUE_TEMPLATE/2_feature_request.yaml +++ /dev/null @@ -1,42 +0,0 @@ -# See: -# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository -# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms -# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms - -name: 🚀 Feature Request -description: Suggest an idea for this project -labels: ["feature request"] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to file a feature request. Please fill out this form as completely as possible. - - type: textarea - attributes: - label: What is the problem this feature will solve? - description: Tell us why this change is needed or helpful and what problems it may help solve. - validations: - required: true - - type: textarea - attributes: - label: What is the feature that you are proposing to solve the problem? - description: Provide detailed information for what we should add. - validations: - required: true - - type: textarea - attributes: - label: What alternatives have you considered? - - type: checkboxes - attributes: - label: Code of Conduct - description: By submitting this issue you agree to follow our [Code of Conduct](../../docs/CODE_OF_CONDUCT.md) - options: - - label: I agree to follow this project's Code of Conduct - required: true - - type: checkboxes - attributes: - label: Sensitive Information Declaration - description: To ensure the utmost confidentiality and protect your 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 form. We appreciate your cooperation in maintaining the security of your information. - options: - - label: I confirm that neither PII/PID nor sensitive data are included in this form - required: true diff --git a/.github/ISSUE_TEMPLATE/3_bug_report.yaml b/.github/ISSUE_TEMPLATE/3_bug_report.yaml deleted file mode 100644 index 12a8c6e..0000000 --- a/.github/ISSUE_TEMPLATE/3_bug_report.yaml +++ /dev/null @@ -1,63 +0,0 @@ -# See: -# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository -# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms -# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms - -name: 🐞 Bug Report -description: File a bug report -labels: ["bug", "triage"] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to file a bug report. Please fill out this form as completely as possible. - - type: checkboxes - attributes: - label: Is there an existing issue for this? - description: Please, search the Issues to see if an issue already exists for the bug you have encountered. - options: - - label: I have searched the existing Issues - required: true - - type: textarea - attributes: - label: Current Behavior - description: A concise description of what you are experiencing. - validations: - required: true - - type: textarea - attributes: - label: Expected Behavior - description: A concise description of what you expect to happen. - validations: - required: true - - type: textarea - attributes: - label: Steps To Reproduce - description: Steps to reproduce the behavior - placeholder: | - 1. In this environment... - 2. With this config... - 3. Run `...` - validations: - required: false - - type: textarea - attributes: - label: Output - description: Please copy and paste any relevant output. This will be automatically formatted into codeblock. - render: Shell - validations: - required: false - - type: checkboxes - attributes: - label: Code of Conduct - description: By submitting this issue you agree to follow our [Code of Conduct](../../docs/CODE_OF_CONDUCT.md) - options: - - label: I agree to follow this project's Code of Conduct - required: true - - type: checkboxes - attributes: - label: Sensitive Information Declaration - description: To ensure the utmost confidentiality and protect your 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 form. We appreciate your cooperation in maintaining the security of your information. - options: - - label: I confirm that neither PII/PID nor sensitive data are included in this form - required: true diff --git a/.vscode/settings.json b/.vscode/settings.json index 423458c..c5488f1 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -3,5 +3,8 @@ "MD013": false, "MD024": { "siblings_only": true }, "MD033": false - } + }, + "cSpell.words": [ + "Licence" + ] } diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8bd0ebf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,5 @@ +# Contributing + +NHS Notify is in the process of migrating to public git hub repositories. + +At present we are not accepting contributions during this phase. public Issues / Support / Tickets should not be raised through github. diff --git a/README.md b/README.md index a14dc29..dd65545 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,30 @@ # NHS Notify -[![CI/CD Pull Request](https://github.com/nhs-england-tools/repository-template/actions/workflows/cicd-1-pull-request.yaml/badge.svg)](https://github.com/nhs-england-tools/repository-template/actions/workflows/cicd-1-pull-request.yaml) -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=repository-template&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=repository-template) +[![CI/CD Pull Request](https://github.com/NHSDigital/nhs-notify/actions/workflows/cicd-1-pull-request.yaml/badge.svg)](https://github.com/NHSDigital/nhs-notify/actions/workflows/cicd-1-pull-request.yaml) -Start with an overview or a brief description of what the project is about and what it does. For example - +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). -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. +## Who/what is this repository is for? -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: +- NHS Developers working on NHS Notify +- Those who are interested in how NHS Notify is architected and developed. -- Terraform -- Docker +## Who/what is this repository not for? -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! +- Customer Support +- Supplier Support ## Table of Contents - [NHS Notify](#nhs-notify) + - [Who/what is this repository is for?](#whowhat-is-this-repository-is-for) + - [Who/what is this repository not for?](#whowhat-is-this-repository-not-for) - [Table of Contents](#table-of-contents) - [Documentation](#documentation) - [Setup](#setup) - [Prerequisites](#prerequisites) - [Configuration](#configuration) - [Usage](#usage) - - [Testing](#testing) - [Design](#design) - [Diagrams](#diagrams) - [Modularity](#modularity) @@ -38,51 +39,20 @@ Make use of this repository template to expedite your project setup and enhance ## Setup -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. - Clone the repository ```shell -git clone https://github.com/nhs-england-tools/repository-template.git -cd nhs-england-tools/repository-template +git clone https://github.com/NHSDigital/nhs-notify.git +cd nhs-notify +code project.code-workspace ``` ### Prerequisites -The following software packages, or their equivalents, are expected to be installed and configured: - -- [Docker](https://www.docker.com/) container runtime or a compatible tool, e.g. [Podman](https://podman.io/), -- [asdf](https://asdf-vm.com/) version manager, -- [GNU make](https://www.gnu.org/software/make/) 3.82 or later, -- [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, -- [Python](https://www.python.org/) required to run Git hooks, -- [`jq`](https://jqlang.github.io/jq/) a lightweight and flexible command-line JSON processor. - -> [!NOTE]
-> 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: -> -> ```shell -> brew install make -> ``` -> -> 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 done for you. - ### Configuration -Installation and configuration of the toolchain dependencies - -```shell -make config -``` - ## Usage -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. - -### Testing - -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. - ## Design ### Diagrams @@ -100,19 +70,11 @@ Most of the projects are built with customisability and extendability in mind. A 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 - Environment setup for contribution, i.e. `CONTRIBUTING.md` -- Coding standards, branching, linting, practices for development and testing -- Release process, versioning, changelog -- Backlog, board, roadmap, ways of working -- High-level requirements, guiding principles, decision records, etc. ## Contacts -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. - ## Licence -> The [LICENCE.md](./LICENCE.md) file will need to be updated with the correct year and owner - Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. Any HTML or Markdown documentation is [© Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/) and available under the terms of the [Open Government Licence v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/). From e5c927c528f4276969266129f0e34311b59fd7e9 Mon Sep 17 00:00:00 2001 From: Ross Buggins Date: Thu, 16 May 2024 13:01:01 +0100 Subject: [PATCH 2/2] Correct spelling. --- CONTRIBUTING.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8bd0ebf..3054906 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,4 +2,4 @@ NHS Notify is in the process of migrating to public git hub repositories. -At present we are not accepting contributions during this phase. public Issues / Support / Tickets should not be raised through github. +At present we are not accepting contributions during this phase. public Issues / Support / Tickets should not be raised through GitHub. diff --git a/README.md b/README.md index dd65545..16609a2 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ NHS Notify - for the NHS Notify web site, onboarding guidance, and customer supp ## Who/what is this repository is for? - NHS Developers working on NHS Notify -- Those who are interested in how NHS Notify is architected and developed. +- Those who are interested in NHS Notify architecture and how it is developed. ## Who/what is this repository not for?