Setting up your private repo

Every student maintains a private repo for their exercises and reflections. This page will describe how to structure this repo.

For information on how to use GitHub, see resources.

Structure

We are relatively agnostic about how you specifically structure your repo, but we essentially expect it to be well-organized enough that we can easily navigate to specific assignments when we are reviewing your work. In particular we recommend an exercises folder and a reflections folder.

You can structure your reflections however you'd like, but please make sure it is easy to find a given section. For example you could maintain one massive journal document with dated headings, or a new file for every assignment, or subfolders...

File structure

One possible repo structure is shown below.

/
|- README.md
|- exercises/
|  |- e1.md
|  |- ...
|- reflections/
|  |- journal.md
|  |- screenshot.png

Document structure

One possible structure for Exercise 1 is shown below.

# Exercise 1: Problem Framing

## Personal Goals

I am taking this class because...

## Problem Statement

### Domain

### Bad situations

1. Situation 1

2. Situation 3

3. Situation 3

### Corroboration

### Workarounds and comparables

**Topic:** lorem ipsum

**Another topic:** the quick brown fox

### Solution sketch