Skip to content

Commit 3930f7a

Browse files
committed
Add maintainer docs
1 parent c4730e4 commit 3930f7a

2 files changed

Lines changed: 54 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing
2+
3+
Contributions are welcome when they improve reproducibility, biological annotation, testing, or figure quality.
4+
5+
## Development setup
6+
7+
```bash
8+
python -m venv .venv
9+
source .venv/bin/activate
10+
pip install -e ".[dev]"
11+
pytest -v
12+
python run_pipeline.py
13+
python scripts/validate_outputs.py
14+
```
15+
16+
## Pull request checklist
17+
18+
- `pytest -v` passes.
19+
- `ruff check` passes for changed Python files.
20+
- `python scripts/validate_outputs.py` passes after any pipeline-output change.
21+
- Changed figures are regenerated intentionally.
22+
- Annotation changes document which marker genes or scoring rules changed.
23+
24+
## Scientific correctness
25+
26+
Cluster labels and trajectory claims should be evidence-backed. If you change cell-type markers, Leiden resolution selection, QC thresholds, or pseudotime rooting, include the effect on cell counts and key figures.
27+
28+
## Licence
29+
30+
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 and correctness fixes are made on the default branch and latest tagged release.
6+
7+
## Reporting a vulnerability
8+
9+
This repository processes AnnData files, CSV files, and generated figures. If you find a vulnerability such as unsafe path handling, dependency supply-chain risk, or malformed input causing unintended writes, do not open a public issue.
10+
11+
Email: evk23umu@uea.ac.uk
12+
Subject: `single-cell-rnaseq security: <short description>`
13+
14+
Please include:
15+
- Reproduction steps
16+
- Python version and operating system
17+
- Input format used
18+
- Expected impact
19+
20+
I aim to respond within 7 days.
21+
22+
## Data handling
23+
24+
Do not attach private single-cell datasets or patient metadata to public issues. Use PBMC 3k, synthetic AnnData files, or redacted examples.

0 commit comments

Comments
 (0)