Skip to content

HASEL-UZH/StudentTemplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 

Repository files navigation

[BT/MT]-[StudentName]-[ProjectName]

This repository contains the material for a Bachelor or Master thesis project supervised at HASEL.

The repository should be private.

The name of the repository should follow this format:

[BT/MT]-[StudentName]-[ProjectName]

Examples:

MT-MariaMuster-ArtifactRetrieval
BT-MaxMeier-TaskTracking

Project Information

Student:
Degree: Bachelor / Master
Project title:
Main supervisor:
PhD advisor:
Start date:
Expected end date:


Project Summary

Briefly describe the project.

Include:

  • The main problem addressed by the project.
  • The goal of the thesis.
  • The expected outcome, such as a prototype, study, analysis, dataset, or written thesis.

Repository Structure

Recommended structure:

.
├── README.md
├── weekly-progress.md
├── code/
│   └── ...
├── documents/
│   ├── proposal/
│   ├── thesis/
│   └── drafts/
├── data/
│   └── README.md
└── results/
    ├── figures/
    ├── tables/
    └── logs/

Folder Description

code/

Contains source code, scripts, notebooks, prototypes, or implementation files.

documents/

Contains written documents related to the thesis, including proposal versions, thesis drafts, notes, and reports.

data/

Contains datasets or information about where the data is stored.

If the data cannot be uploaded to GitHub, explain where it is stored and how it can be accessed.

Do not upload sensitive or private data unless explicitly approved by the supervisor.

results/

Contains outputs produced during the project, such as figures, tables, logs, screenshots, evaluation results, or analysis outputs.


Weekly Progress

Weekly progress must be documented in:

weekly-progress.md

The student should update it every 1-2 weeks before the supervision meeting.


Repository Rules

  • The repository must remain private.
  • Keep the repository organized.
  • Use clear file and folder names.
  • Commit work regularly.
  • Link relevant commits, documents, and results in weekly-progress.md.
    • When sending an email to the advisor with data, code, results, or documents to review, send only the link to the corresponding artifact in this repository.
  • Do not commit temporary files, system files, or unrelated files.
  • Do not upload sensitive, private, or confidential data unless explicitly approved.
  • If large files or datasets cannot be stored in GitHub, add a short explanation in data/README.md.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors