Skip to content

github.md

Latest commit

 

History

History
65 lines (49 loc) · 3.55 KB

github.md

File metadata and controls

65 lines (49 loc) · 3.55 KB

Instructions for course submissions via GitHub

Each student must create and maintain their own GitHub repository for this course. This repository will contain all required submissions: presentations of readings, presentation of research, final paper, and code and data.

One-time setup

  1. Create a GitHub account if you do not already have one. This is completely free. Several GitHub services are also available to students for free, so sign up with your UCSC email address to benefit from those. Please use a professional ID such as firstname_lastname.
  2. Watch the course portal on GitHub to be notified when any new material is uploaded, new discussions are started, and new contributions are made to ongoing discussions. To watch the repository, sign in, click on the Watch button at the top of the GitHub repository, and select All Activity.
  3. Create a new repository in your GitHub account named econ221_fall2025.
  4. If you wish to keep your repository private, add the instructor (pmichaillat) as a collaborator with read access. This can be done by clicking on Settings → Collaborators → Add people. Ensure the instructor has read access at all times.
  5. Next, to help you manage your GitHub repository, install GitHub Desktop on your computer. With GitHub Desktop you will easily be able to upload local files into your online repository.
  6. Use GitHub Desktop to clone the repository to your computer: File → Clone Repository, select your repository, and save it to your computer.

Repository structure

  • Your course repository should be organized as follows:
.
├── reading_presentations
│   ├── week1.pdf
│   ├── week4.pdf
│   └── week7.pdf
├── research_presentations
│   ├── projectoutline.pdf
│   ├── earlyresults.pdf
│   └── finalresults.pdf
├── research_paper
│   └── paper.pdf
└── code_data
    └── [your scripts, notebooks, datasets, spreadsheets]
  • /reading_presentations/ - Folder with your presentations of readings. One PDF per presentation, named according to the week of the presentation.
  • /research_presentations/ - Folder with your presentations of research. One PDF per presentation, named according to the research stage.
  • /research_paper/ - Folder with your final research paper.
  • /code_data/ - Folder with all scripts, notebooks, datasets, spreadsheets, or other code used in your research.
  • You can organize the repository directly on your computer, using the cloned version of the repository.
  • GitHub does not track empty folders, only files. To ensure that the folder structure exists in your repository before you place any files in it, place a dummy file named .gitkeep inside each empty folder. The dummy file will ensure that the otherwise-empty folders appear on GitHub.

Weekly workflow

  1. Place new files in the correct folder with correct filenames on your computer.
  2. Open GitHub Desktop and select your course repository.
  3. Write a commit message, such as Submit presentation of early results or Submit research paper
  4. Click Commit to main
  5. Click Push origin
  6. Confirm your files appear online in your GitHub repository.

Submission rules

  • Deadline: all required files must be pushed to GitHub before the deadlines.
  • Format: PDF for presentations and paper. Code must run from /code_data/.
  • Locations and names: files must be in the specified folders with the specified names.