Skip to content

Commit 7fc32e7

Browse files
Add SOP for building new GDSC projects
1 parent 4950c8d commit 7fc32e7

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

SOP.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# GDSC: Building a new project SOP
2+
3+
## Initializing a project repo
4+
5+
1. Create a new private github repository initialized with a README.md
6+
2. Naming convention should be as follows: `YYMMDD-Client-Description`
7+
3. On Github Desktop or Git, clone the repository to the respective client folder on Discovery within GMBSR_bioinfo. For example, if the project is 260101-Smith-RNASeq, clone the repo to GMBSR_bioinfo/Labs/smith
8+
9+
## Updating the project master list
10+
11+
For organization and a public-facing record of our work it is important to update the master list of project housed in the [GDSC-Projects Repo](tps://github.com/Dartmouth-Data-Analytics-Core/GDSC-Projects/). The README.md
12+
on that repository contains drop down lists of projects, split by client. Client names follow alphabetical order. Information included in each client table includes the repo name, a data-modality category, a link to the
13+
private repo (which only GDSC team members can access) and the date the repo was added. A Github action is set such that every time this README.md is modified, or a change is pushed to this repo, a tally of modalities
14+
will be updated. **You do not need to manually change this in the readme!** The script which completes the tallying is set to accept harmonized alises for each data modality, but new terms can be addedd in as well within the
15+
script [here](https://github.com/Dartmouth-Data-Analytics-Core/GDSC-Projects/blob/main/scripts/tallyModalities.py) under the `ALIASES` section. Any term not included in the alises will be counted as its own category.
16+
17+
**For new clients not already listed:**
18+
19+
1. Create a new header for this client by alphabetically placing their name within the list using this structure: *You can just copy and paste a block from the README.md and edit as necessary!*
20+
21+
```
22+
<details>
23+
<summary>ClIENT LAST NAME</summary>
24+
25+
| Project | Modality | Repo | Date|
26+
|----------|-----------|------|----|
27+
|REPO NAME| DATA MODALITY| [Github](https://github.com/link/to/repo/)| MM/DD/YYYY |
28+
29+
</details>
30+
31+
```
32+
33+
**Formatting details**
34+
35+
- Repo name should be exactly as it appears on github
36+
- Modality should typically match one of the aliases in `scripts/tallyModalities.py`, or a new aslias should be added directly to the script (ex, try and avoid having RNA-Seq in some places and RNAseq in others)
37+
- Repo should be a clickable hyperlink called "Github". To create hyperlinks in markdown use this convention: [Github](htpps://github.com/link/to/repo/)
38+
- Date column should be in MM/DD/YYYY format
39+
40+
41+
**For clients already listed**
42+
43+
1. Locate the client on the README.md and edit to add a new row to their table
44+
45+
```
46+
| Project | Modality | Repo | Date|
47+
|----------|-----------|------|----|
48+
|REPO NAME| DATA MODALITY| [Github](https://github.com/link/to/repo/)| MM/DD/YYYY |
49+
|NEW PROJECT| DATA MODALITY| [Github](https://github.com/link/to/new_repo/)| MM/DD/YYYY |
50+
51+
```
52+
53+

0 commit comments

Comments
 (0)