Skip to content

Commit 438de78

Browse files
anthony-nhsanthony-nhs
committed
add common files
1 parent 34fc02c commit 438de78

File tree

4 files changed

+193
-0
lines changed

4 files changed

+193
-0
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎CONTRIBUTING.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Contribution Guidelines
2+
3+
## Raising an Issue
4+
5+
If you raise an issue against this repository, please include as much information as possible to reproduce any bugs,
6+
or specific locations in the case of content errors.
7+
8+
## Contributing code
9+
10+
To contribute code, please fork the repository and raise a pull request.
11+
12+
Ideally pull requests should be fairly granular and aim to solve one problem each. It would also be helpful if they
13+
linked to an issue. If the maintainers cannot understand why a pull request was raised, it will be rejected,
14+
so please explain why the changes need to be made (unless it is self-evident).
15+
16+
### Merge responsibility
17+
18+
- It is the responsibility of the reviewer to merge branches they have approved.
19+
- It is the responsibility of the author of the merge to ensure their merge is in a mergeable state.
20+
- It is the responsibility of the maintainers to ensure the merge process is unambiguous and automated where possible.
21+
22+
### Branch naming
23+
24+
Branch names should be of the format:
25+
26+
`aea-nnn-short-issue-description`
27+
28+
Multiple branches are permitted for the same ticket.
29+
30+
### Commit messages
31+
32+
We do not enforce any conventions on commit messages to a branch, as we use squash commits when merging to main branch.
33+
34+
Commits from a pull request get squashed into a single commit on merge, using the pull request title as the commit message.
35+
Please format your pull request title using tags from [ESLint Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint) as follows:
36+
37+
```text
38+
Tag: [AEA-NNNN] - Short description
39+
```
40+
41+
Tag can be one of:
42+
43+
- `Fix` - for a bug fix. (Patch release)
44+
- `Update` - either for a backwards-compatible enhancement or for a rule change that adds reported problems. (Patch release)
45+
- `New` - implemented a new feature. (Minor release)
46+
- `Breaking` - for a backwards-incompatible enhancement or feature. (Major release)
47+
- `Docs` - changes to documentation only. (Patch release)
48+
- `Build` - changes to build process only. (No release)
49+
- `Upgrade` - for a dependency upgrade. (Patch release)
50+
- `Chore` - for refactoring, adding tests, etc. (anything that isn't user-facing). (Patch release)
51+
52+
If the current release is x.y.z then
53+
- a patch release increases z by 1
54+
- a minor release increases y by 1
55+
- a major release increases x by 1
56+
57+
Correct tagging is necessary for our automated versioning and release process ([Release](./RELEASE.md)).
58+
59+
### Changelog
60+
61+
Release changelogs are generated from the titles of pull requests merged into the `main` branch. Please ensure that your pull request title is sufficiently descriptive of the changes made.

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Crown Copyright (c)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎SECURITY.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Security
2+
3+
NHS England takes security and the protection of private data extremely seriously. If you believe you have found a vulnerability or other issue which has compromised or could compromise the security of any of our systems and/or private data managed by our systems, please do not hesitate to contact us using the methods outlined below.
4+
5+
## Table of Contents
6+
7+
- [Security](#security)
8+
- [Table of Contents](#table-of-contents)
9+
- [Reporting a vulnerability](#reporting-a-vulnerability)
10+
- [Email](#email)
11+
- [NCSC](#ncsc)
12+
- [General Security Enquiries](#general-security-enquiries)
13+
14+
## Reporting a vulnerability
15+
16+
Please note, email is our preferred method of receiving reports.
17+
18+
### Email
19+
20+
If you wish to notify us of a vulnerability via email, please include detailed information on the nature of the vulnerability and any steps required to reproduce it.
21+
22+
You can reach us at:
23+
24+
- [epssupport@nhs.net](epssupport@nhs.net)
25+
- [cybersecurity@nhs.net](cybersecurity@nhs.net)
26+
27+
### NCSC
28+
29+
You can send your report to the National Cyber Security Centre, who will assess your report and pass it on to NHS England if necessary.
30+
31+
You can report vulnerabilities here: [https://www.ncsc.gov.uk/information/vulnerability-reporting](https://www.ncsc.gov.uk/information/vulnerability-reporting)
32+
33+
## General Security Enquiries
34+
35+
If you have general enquiries regarding our cybersecurity, please reach out to us at [cybersecurity@nhs.net](cybersecurity@nhs.net)

0 commit comments

Comments
 (0)