Skip to content

Commit 727f4e5

Browse files
committed
Add citation and maintainer docs
1 parent 7f4cea8 commit 727f4e5

4 files changed

Lines changed: 77 additions & 0 deletions

File tree

CITATION.cff

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
cff-version: 1.2.0
2+
message: "If you reference this prototype, please cite the repository."
3+
title: "SafetyNett: AI-assisted clinical safety-netting prototype"
4+
type: software
5+
license: MIT
6+
repository-code: "https://github.com/Ekin-Kahraman/safetynett"
7+
url: "https://github.com/Ekin-Kahraman/safetynett"
8+
abstract: "A React, TypeScript and Supabase prototype for AI-assisted primary-care safety-netting, red-flag detection, patient follow-up, and GP escalation."
9+
keywords:
10+
- digital health
11+
- clinical safety
12+
- safety-netting
13+
- TypeScript
14+
- Supabase
15+
- NHS
16+
authors:
17+
- family-names: "Kahraman"
18+
given-names: "Ekin"
19+
affiliation: "University of East Anglia"
20+
email: "evk23umu@uea.ac.uk"

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing
2+
3+
Contributions are welcome when they improve clinical safety, product robustness, accessibility, tests, or documentation.
4+
5+
## Development setup
6+
7+
```bash
8+
npm install
9+
npm run lint
10+
npm run typecheck
11+
npm run build
12+
npm test
13+
```
14+
15+
Local development requires Supabase and email-provider credentials in `.env`. Do not commit real secrets.
16+
17+
## Pull request checklist
18+
19+
- `npm run lint` passes.
20+
- `npm run typecheck` passes.
21+
- `npm run build` passes.
22+
- `npm test` passes.
23+
- Clinical logic changes include the source or guideline basis.
24+
- No real patient data, credentials, or production identifiers are committed.
25+
26+
## Clinical safety
27+
28+
SafetyNett is a prototype. Any change to red-flag logic, escalation routing, patient communication, or verification flow should be reviewed as a clinical-safety change and documented in the pull request.
29+
30+
## Licence
31+
32+
By contributing, you agree that your contributions are licensed under the MIT licence.

SECURITY.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Security policy
2+
3+
## Supported versions
4+
5+
Security fixes are made on the default branch. This is a hackathon prototype and is not approved for clinical deployment.
6+
7+
## Reporting a vulnerability
8+
9+
If you find a vulnerability involving authentication, Supabase access, patient-data handling, email or voice follow-up, prompt injection, or escalation logic, do not open a public issue.
10+
11+
Email: evk23umu@uea.ac.uk
12+
Subject: `safetynett security: <short description>`
13+
14+
Please include:
15+
- Reproduction steps
16+
- Browser and operating system
17+
- Whether a local or cloud environment was used
18+
- Expected impact
19+
20+
I aim to respond within 7 days.
21+
22+
## Data handling
23+
24+
Do not enter real patient data, NHS numbers, phone numbers, clinical records, or credentials into public issues, screenshots, or demo environments. Use synthetic patients only.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"name": "safetynett",
33
"private": true,
44
"version": "1.0.0",
5+
"license": "MIT",
56
"type": "module",
67
"scripts": {
78
"dev": "vite",

0 commit comments

Comments
 (0)