The UC Berkeley School of Information GitHub org hosts a wide variety of repos. Provided they conform to the acceptable use policy, repos may be:
- created by faculty, staff or students
- long-lived or short-lived
- used for group work or individual work
As the number of repos in this GitHub org increases, a clear and universally applied naming convention is critical to ensure that the org remains usable.
The following rules should be applied from left to right when naming a repo:
- Program name: All repo names should begin with the name of their associated degree program: MICS, MIDS or MIMS
- Course number: All repo names should include the number of their associated course: w241, 241, etc. Please note that course numbers are sometimes shared across MICS, MIDS and MIMS programs, so course number alone is not unique
- Description: A description is required for any repo used for student work. Descriptions can be any of the following:
- your full name
- your School of Information user ID
- your group name: If this repo supports a service hosted on https://groups.ischool.berkeley.edu, please use the group name as the description
- your project name: If this repo supports a project, such as a Capstone class final project, please use your project name as the description
- Term: Term is required for any repo used for student work. Valid term names include both the session and year for the 2020 -2021 academic year are:
- Fall20 or Fall2020
- Winter21 or Winter2021
- Summer21 or Summer2021
The following are all valid examples of repo names created by faculty to support instruction:
- mids-1D-computing-basics
- mids-w200-course-syllabus
- mids-w241
The following are valid names for student repos:
- mids-w200-john-doe-spring21
- mids-w210-hella-capstone-project-winter2021
The School of Information IT team reserves the right to rename repos to bring them into compliance with this policy. We will notify repo owners when we take action, provided we can clearly identify the repo owner.