Skip to content

Commit 104a52b

Browse files
committed
Add maintainer docs
1 parent 44568a1 commit 104a52b

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, statistical correctness, documentation, or output validation.
4+
5+
## Development setup
6+
7+
```bash
8+
Rscript 000_install_dependencies.R
9+
Rscript scripts/12_output_manifest.R
10+
Rscript -e 'testthat::test_dir("tests/testthat")'
11+
Rscript dev/lint.R
12+
```
13+
14+
The full rebuild path is checked in CI. Run the narrow tests locally before opening a pull request.
15+
16+
## Pull request checklist
17+
18+
- Tests pass with `testthat`.
19+
- `Rscript dev/lint.R` reports no lints.
20+
- Changed analysis outputs are regenerated intentionally.
21+
- `results/tables/output_manifest.csv` is updated when tracked outputs change.
22+
- Any changed statistical threshold, design formula, contrast, or filtering rule is documented in the README.
23+
24+
## Scientific correctness
25+
26+
Do not change reported results silently. If a change affects differential-expression counts, enrichment results, or figures, include the before and after numbers in the pull request.
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 public GEO data and local tabular files. If you find a vulnerability such as unsafe file handling, credential leakage, or a supply-chain issue in dependency restoration, do not open a public issue.
10+
11+
Email: evk23umu@uea.ac.uk
12+
Subject: `bulk-rnaseq security: <short description>`
13+
14+
Please include:
15+
- Reproduction steps
16+
- R version and operating system
17+
- Whether `renv` restore was used
18+
- Expected impact
19+
20+
I aim to respond within 7 days.
21+
22+
## Data handling
23+
24+
Do not attach private patient metadata, raw clinical files, or access credentials to public issues. Use public accession IDs or redacted synthetic examples.

0 commit comments

Comments
 (0)