Conversation
|
This PR is linked to a ticket in an NHS Digital JIRA Project. Here's a handy link to the ticket: AEA-0000 |
There was a problem hiding this comment.
Pull request overview
Adds standard community and governance documentation (security, license, contributing, code of conduct) and refreshes the development container image version.
Changes:
- Add SECURITY.md, LICENSE, CONTRIBUTING.md, and CODE_OF_CONDUCT.md to standardise repo documentation.
- Update
.devcontainer/devcontainer.jsonto use devcontainer image versionv1.4.2.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| SECURITY.md | Adds security reporting guidance and contact details. |
| LICENSE | Adds an MIT license file. |
| CONTRIBUTING.md | Adds contribution, branching, and commit message guidance. |
| CODE_OF_CONDUCT.md | Adds Contributor Covenant code of conduct. |
| .devcontainer/devcontainer.json | Bumps devcontainer image version to v1.4.2. |
| You can reach us at: | ||
|
|
||
| - [epssupport@nhs.net](epssupport@nhs.net) | ||
| - [cybersecurity@nhs.net](cybersecurity@nhs.net) | ||
|
|
There was a problem hiding this comment.
The email links are currently written as regular Markdown links, which will be treated as relative URLs (e.g., linking to a non-existent file named "epssupport@nhs.net"). Use a proper email link format (e.g., a mailto: URL or angle-bracket autolink) so clicking opens an email client.
| ## General Security Enquiries | ||
|
|
||
| If you have general enquiries regarding our cybersecurity, please reach out to us at [cybersecurity@nhs.net](cybersecurity@nhs.net) |
There was a problem hiding this comment.
This email reference is also formatted as a regular Markdown link, which will resolve as a relative URL rather than an email link. Switch to a mailto: (or autolink) format to ensure it works correctly.
| @@ -0,0 +1,21 @@ | |||
| MIT License | |||
|
|
|||
| Crown Copyright (c) | |||
There was a problem hiding this comment.
The MIT license header typically includes a year and the copyright holder (e.g., "Copyright (c) "). As written, "Crown Copyright (c)" is missing the year/holder details, which can create ambiguity about ownership and the applicable period—please update the header to the standard MIT form used by this project/organisation.
| Crown Copyright (c) | |
| Crown Copyright (c) 2024 NHS England |
| Every pull request must include a change to the changelog. | ||
|
|
||
| Add changes to the top of the current date. If the date is old, the reviewer should update the changelog to be correct before merging. |
There was a problem hiding this comment.
This section mandates that every pull request updates a changelog, but there is no changelog file in this repository. Either add the referenced changelog (and specify its expected name/location) or adjust the guidance to match the repo’s actual release/change tracking process.
| Every pull request must include a change to the changelog. | |
| Add changes to the top of the current date. If the date is old, the reviewer should update the changelog to be correct before merging. | |
| If this repository has a changelog (for example, a `CHANGELOG.md` file in the repository root), every pull request must ensure it is updated appropriately. | |
| If no changelog is present, document your changes according to this repository's release process (for example, GitHub Releases or a "Release notes" section in the README). |
Summary
Details