Skip to content

Commit

Permalink
add instructions for git, dry lab cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
lhao03 committed Feb 15, 2024
1 parent b4efc83 commit e4ca917
Show file tree
Hide file tree
Showing 8 changed files with 64 additions and 18 deletions.
16 changes: 9 additions & 7 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
- [February](./wet-lab/notebook/february.md)
- [Design](./wet-lab/design/index.md)
- [Plasmid Design](./wet-lab/design/plasmid.md)
- [Experiment Design](./wet-lab/design/experiment.md)
- [ssDNA to dsDNA Experimental Design](./wet-lab/design/dsdna-experiment.md)
- [Solid phase DNA Synthesis Experimental Design](./wet-lab/design/dsdna-experiment.md)
- [Engineering Success](./wet-lab/engineering/index.md)
- [Parts](./wet-lab/parts/index.md)
- [Results](./wet-lab/results/index.md)
Expand All @@ -30,12 +31,13 @@
- [Overview](./dry-lab/index.md)
- [Software](./dry-lab/software/index.md)
- [GUI](./dry-lab/software/gui.md)
- [Encoding and Decoding](./dry-lab/software/encoding-decoding.md)
- [Block Based Semantics](./dry-lab/software/block.md)
- [DNA as Persistent Data Structure](./dry-lab/software/persistence.md)
- [Protein Modelling](./dry-lab/protein-modelling/index.md)
- [Math Modelling](./dry-lab/math-modelling/index.md)
- [Bioinformatics](./dry-lab/bioinformatics/index.md)
- [Encoding](./dry-lab/software/encoding-decoding.md)
- [Decoding](./dry-lab/software/block.md)
- [Modelling](./dry-lab/modelling/index.md)
- [Microfluidics](./dry-lab/microfluidics/index.md)
- [Individual Progress](./dry-lab/individual-prog/index.md)
- [Dry Lab Member Name]()


# Human Practices

Expand Down
24 changes: 23 additions & 1 deletion src/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,28 @@

<!-- toc -->

## How to use the internal wiki with Codespaces
1. If you haven't already opened a Codespace, open a new Codespace and **do not** hit anything while the Codespace starts up.
2. Once the Codespace is done downloading all the packages required, run `mdbook serve` to start up a local version of the internal wiki.
3. Now follow the instructions for [adding changes to GitHub](#adding-changes-to-github)

## Adding changes to GitHub
1. Open up the internal wiki on Codespaces or your local development environment.
2. Before you add any changes, run `git pull`. This ensures that your local version of the internal wiki is updated with other people's changes. If you don't do this step you make end up with merge conflicts. If running `git pull` results in merge conflicts (it shouldn't if you're always running `git pull`), let Lucy or a wiki liaison know.
3. Make a new branch `git branch [name-subteam-description]`. Then switch to that branch, `git checkout [name-subteam-description]`. Someone would run:
```git
git branch lucy-drylab-software
git checkout lucy-drylab-software
```
4. Now you can write your updates in!
5. When you are ready to publish your updates, you will need to save your files. In git, this is called making a commit. Git provides finer grain control, meaning you can choose which files to save in a project; most of the time you want to save all the files you have modified. Run `git add .`. This adds all modified and created files to the staging area.
6. Once you are satisfied with the files in the staging area, run `git commit -m "[message]"`. Replace `[message]` with a meaningful message related to your changes.
7. Finally, you can run `git push`. Make sure you are pushing to the UBC iGEM repo, if asked where to push, push to the repo with the link [https://github.com/UBC-iGEM/internal-wiki-2023-24]; you can push to your own fork, but please enable this [setting](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork).
8. Following the prompts on Codespaces or the GitHub website, make a PR. That's it! Leads and wiki liaisons will check your content and approve and merge your PR.

## How to use mdBook locally
mdBook is an open source project developed by the Rust Foundation for documenting Rust packages. If you're running Windows, I recommend you get WSL. You can get started [here](https://rust-lang.github.io/mdBook/guide/installation.html). Let Lucy know if you have any issues.

## How to write Markdown

Check out the [CommonMark quick reference](https://commonmark.org/help/) first. Much of this document is borrowed from the rustdoc book[^rust].
Expand Down Expand Up @@ -68,7 +90,7 @@ If you want to see all the Markdown features available to you, here is the [spec

## How to add new pages and subsections

Open the [Internal Wiki](https://github.com/UBC-iGEM/internal-wiki-2023-24) in a Codespace. Follow the instructions [here](https://rust-lang.github.io/mdBook/format/summary.html) on how to add new pages and subsections. When are you creating new pages, please follow these file naming conventions. Any files that don't conform to these file naming conventions will not be accepted as documentation.
Run `mdbook serve`, then follow the instructions [here](https://rust-lang.github.io/mdBook/format/summary.html) on how to add new pages and subsections. When are you creating new pages, please follow these file naming conventions. Any files that don't conform to these file naming conventions will not be accepted as documentation.

1. Only punctuation that is allowed are dashes.
2. All lowercase.
Expand Down
16 changes: 16 additions & 0 deletions src/documentation/liaison.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,22 @@ Thirdly, after you have ensured your subteam is contributing to the internal wik

Finally, when we are writing the wiki for the iGEM Jamboree, you will have a greater hand in helping the leads design the wiki. You may also help assign other subteam members to writing and reading content.

## How do I review writing?
### Reviewing wet lab writing
These criteria are nonnegotiable:
1. Citations, in the proper format (APA)
2.



### Reviewing dry lab writing
These criteria are nonnegotiable:
1. Citations, in the proper format (APA)
2. For anything code-based: a GitHub repo containing the code in question


### Reviewing human practices writing

## Who do I ask for help?
At anytime if you feel this role is overwhelming let the co-directors or Lucy know. We will probably have weekly asynchronous updates on Slack, with meetings if necessary.

Expand Down
1 change: 1 addition & 0 deletions src/dry-lab/individual-prog/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Individual Progress
1 change: 1 addition & 0 deletions src/dry-lab/microfluidics/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# microfluidics
1 change: 1 addition & 0 deletions src/dry-lab/modelling/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Modelling
22 changes: 12 additions & 10 deletions src/dry-lab/software/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,19 @@

### Graphical User Interface

### "Block" Based Semantics
- Implementation and metadata in software
- Primer constraints (find OS implementation)
- Distance
- Biological

### Encoding and Decoding
### Encoding
- Redundancy
- Mapping of primers back to address space in software
- Primer generation
- Rotation based cipher
- Segmentation (blocks) of information

### Decoding
- Error correction
- Image processing
- Fuzzy string matching of primers with variable lengths of DNA sequences
- Reconstructing the file in software

### DNA as a Persistent Data Structure
- Primer Generation
- Reconstructing the file in software
- Metadata stored in software
- Generation of primers
- Reconstructing the file with updates in software
1 change: 1 addition & 0 deletions src/wet-lab/design/dsdna-experiment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Solid phase DNA syntehsis Experimental Design

0 comments on commit e4ca917

Please sign in to comment.