Skip to content

Explanation for different semesterly repos #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pancakereport merged 1 commit into from
Aug 1, 2025
Merged

Explanation for different semesterly repos #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion github/github-organizations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ DSUS has a [GitHub Enterprise instance](https://github.com/enterprises/dsus). DS
DSUS has one GitHub Organization per class. For courses using DataHub, typically there are three repositories created each semester:
* **Semester Website.** This public repository holds the Jekyll website for a single semester. Typically named semYY: `spYY | suYY | faYY`.
* **Student Materials.** This public repository holds the Jupyter Notebooks for all components of the course including lectures and student assignments. Student assignments are usually the output of running `otter assign`. Each course has their own naming philosphy, but commonly `semYY-student` or `semYY-materials`
* **Unreleased Materials.** This private repository is used for development of Jupyter Notebooks and other assignments. These repositories are typically named `semYY-dev` or `materials-semYY-private`.
* **Unreleased Materials.** This private repository is used for development of Jupyter Notebooks and other assignments. These repositories are typically named `semYY-dev` or `materials-semYY-private` and may hold solutions to assignments. This repository is where `otter assign` is run.

We recommend two materials repositories for assignment distribution workflows that utilize nbgitpuller to distribute assignments to complete on the DataHub. nbgitpuller will pull **all** materials from a repository onto the DataHub, so assignments that are not ready to distribute and solutions absolutely should not be in the repository used to generate nbgitpuller links. Additionally, classes have run into issues in the past with nbgitpuller's automatic merge behavior so we highly recommend that materials are only added to the Student Materials repository once they are 100% completely finalized.

Because nbgitpuller will pull all materials from a repository, we recommend that the Student Materials repository is as lean as possible. Do not add any extraneous files that are not needed for students to complete their assignments to this repository in order to save costs on the DataHub.

Other repositories in these organizations include exams, private grading repositories (grading scripts and *no student data*), textbooks, and guides.

Expand Down
Loading