Skip to content

Commit f828a35

Browse files
Enhance SOP with repository documentation guidelines
Added guidelines for repository documentation and contents.
1 parent 85464b5 commit f828a35

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

SOP.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,28 @@ If the client already exists, simply add a new row to their project table.
7373

7474
- Date column should be in MM/DD/YYYY format
7575

76+
## Repository Documentation and Contents
77+
78+
Project repositories should be documented in as-similar of a manner as possible such that data provenance is clear, script descriptions are clear, and reasoning for each step is clear. Doing so allows:
79+
80+
- Future you and/or future core-personnel can know and understand what was done
81+
82+
- Enables reproducibility, accountability, and trust
83+
84+
Each repository README.md should contain the following *bare-minimum* information:
85+
86+
```
87+
## Repo Name
88+
Author:
89+
90+
## Background
91+
Brief background of the project, inputs, and expected deliverables as listed in the client quote
92+
93+
## Methods summary, OR detailed per-script documentation
94+
95+
## Software environments
96+
```
97+
98+
Each repository should contain a .gitignore file specifying which output folders/ miscellaneous folders to ignore. Ideally, the only information on these repositories should be a `code` or `scripts` folder, software environment files (conda.yaml, singularity.sif, singularity.def, RSessionInfo.txt, etc...) and any READMEs or project specific documentation.
99+
76100

0 commit comments

Comments
 (0)