Skip to content

Commit e20ce45

Browse files
wildjameswildjames
committed
Add boilerplate
1 parent 023955b commit e20ce45

File tree

6 files changed

+275
-1
lines changed

6 files changed

+275
-1
lines changed

‎.devcontainer/devcontainer.json‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu
3+
{
4+
"name": "Ubuntu",
5+
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
6+
"build": {
7+
"dockerfile": "mcr.microsoft.com/devcontainers/universal:linux"
8+
},
9+
"mounts": [
10+
"source=${env:HOME}${env:USERPROFILE}/.ssh,target=/home/vscode/.ssh,type=bind",
11+
"source=${env:HOME}${env:USERPROFILE}/.gnupg,target=/home/vscode/.gnupg,type=bind"
12+
],
13+
"containerUser": "vscode",
14+
"features": {},
15+
"customizations": {
16+
"vscode": {
17+
"extensions": [
18+
"AmazonWebServices.aws-toolkit-vscode",
19+
"redhat.vscode-yaml",
20+
"eamodio.gitlens",
21+
"github.vscode-pull-request-github",
22+
"streetsidesoftware.code-spell-checker",
23+
"timonwong.shellcheck",
24+
"github.vscode-github-actions"
25+
],
26+
"settings": {
27+
"cSpell.words": ["fhir", "Formik", "pino", "serialisation"]
28+
}
29+
}
30+
}
31+
}

‎.github/pull_request_template.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
## Summary
2+
3+
**Remove items from this list if they are not relevant. Remove this line once this has been done**
4+
5+
- Routine Change
6+
- :exclamation: Breaking Change
7+
- :robot: Operational or Infrastructure Change
8+
- :sparkles: New Feature
9+
- :warning: Potential issues that might be caused by this change
10+
11+
### Details
12+
13+
Add any summary information of what is in the change. **Remove this line if you have nothing to add.**
14+
15+
## Pull Request Naming
16+
17+
Pull requests should be named using the following format:
18+
19+
```text
20+
Tag: [AEA-NNNN] - Short description
21+
```
22+
23+
Tag can be one of:
24+
25+
- `Fix` - for a bug fix. (Patch release)
26+
- `Update` - either for a backwards-compatible enhancement or for a rule change that adds reported problems. (Patch release)
27+
- `New` - implemented a new feature. (Minor release)
28+
- `Breaking` - for a backwards-incompatible enhancement or feature. (Major release)
29+
- `Docs` - changes to documentation only. (Patch release)
30+
- `Build` - changes to build process only. (No release)
31+
- `Upgrade` - for a dependency upgrade. (Patch release)
32+
- `Chore` - for refactoring, adding tests, etc. (anything that isn't user-facing). (Patch release)
33+
34+
If the current release is x.y.z then
35+
- a patch release increases z by 1
36+
- a minor release increases y by 1
37+
- a major release increases x by 1
38+
39+
Correct tagging is necessary for our automated versioning and release process.
40+
41+
The description of your pull request will be used as the commit message for the merge, and also be included in the changelog. Please ensure that your title is sufficiently descriptive.
42+
43+
### Rerunning Checks
44+
45+
If you need to rename your pull request, you can restart the checks by either:
46+
47+
- Closing and reopening the pull request
48+
- pushing an empty commit
49+
```bash
50+
git commit --allow-empty -m 'trigger build'
51+
git push
52+
```
53+
- Amend your last commit and force push to the branch
54+
```bash
55+
git commit --amend --no-edit
56+
git push --force
57+
```
58+
59+
Rerunning the checks from within the pull request will not use the updated title.

‎.vscode/eps-workflow-quality-checks.code-workspace‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
{
2+
"folders":[
3+
{
4+
"name": "eps-workflow-quality-checks",
5+
"path": "."
6+
}
7+
],
8+
"settings": {
9+
"cSpell.words": [
10+
"apigw",
11+
"ASID",
12+
"AWSKMS",
13+
"Caldicott",
14+
"canonicalise",
15+
"Canonicaliser",
16+
"canonicalization",
17+
"Canonicalized",
18+
"Codeable",
19+
"codeinline",
20+
"codesystem",
21+
"devcontainer",
22+
"electronic-prescription-service-clinical-prescription-tracker",
23+
"esbuild",
24+
"fhir",
25+
"Formik",
26+
"Fulfillment",
27+
"Hashable",
28+
"healthcheck",
29+
"Helpdesk",
30+
"homecare",
31+
"HSCN",
32+
"liter",
33+
"milliliter",
34+
"NHSD",
35+
"nhsdlogin",
36+
"nhslogin",
37+
"NOSONAR",
38+
"OIDC",
39+
"Orthoptist",
40+
"Payor",
41+
"pino",
42+
"pollable",
43+
"powertools",
44+
"Prosthetist",
45+
"querystring",
46+
"reingest",
47+
"reingested",
48+
"Reingestion",
49+
"serialisation",
50+
"smartcard",
51+
"smartcards",
52+
"Snomed",
53+
"sourcetype",
54+
"Truststore",
55+
"URID",
56+
"URPID",
57+
"vars",
58+
"versionable",
59+
"whens"
60+
],
61+
"cSpell.dictionaries": [
62+
"en-GB"
63+
],
64+
"cSpell.ignorePaths": [
65+
"package-lock.json",
66+
"node_modules",
67+
".vscode"
68+
],
69+
}
70+
}

‎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: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contribution Guidelines
2+
3+
## Raising an Issue
4+
If you raise an issue against this repository, please include as much information as possible to reproduce any bugs,
5+
or specific locations in the case of content errors.
6+
7+
## Contributing code
8+
To contribute code, please fork the repository and raise a pull request.
9+
10+
Ideally pull requests should be fairly granular and aim to solve one problem each. It would also be helpful if they
11+
linked to an issue. If the maintainers cannot understand why a pull request was raised, it will be rejected,
12+
so please explain why the changes need to be made (unless it is self-evident).
13+
14+
### Merge responsibility
15+
* It is the responsibility of the reviewer to merge branches they have approved.
16+
* It is the responsibility of the author of the merge to ensure their merge is in a mergeable state.
17+
* It is the responsibility of the maintainers to ensure the merge process is unambiguous and automated where possible.
18+
19+
### Branch naming
20+
Branch names should be of the format:
21+
22+
`aea-nnn-short-issue-description`
23+
24+
Multiple branches are permitted for the same ticket.
25+
26+
### Commit messages
27+
Commit messages should be formatted as follows:
28+
```
29+
AEA-NNN Summary of changes
30+
31+
Longer description of changes if explaining rationale is necessary,
32+
limited to 80 columns and spanning as many lines as you need.
33+
```
34+
35+
### Changelog
36+
Every pull request must include a change to the changelog.
37+
38+
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.

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 NHS Digital
3+
Crown Copyright (c)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)