naming-standards.md

Git REPO and YouTube Video Naming Standards

Git Repository layout

/(course_name)
|+ README.md //(#course-readme)
| 
|- 1st-week //(#weekly-directory)
|  |
|  |+ README.md //(#weekly-readme)
|  |  
|  |- sept-24-auth //(#daily-directory)
|  |  |
|  |  |+ slides.file 
|  |  |+ README.md //(#daily-readme)
|  |  | 
|  |  |- lecture-code
|  |  |  |+ README.md //(#daily-lecture-code-readme)
|  |  |  |+ code_from_class*.(js|rb|py|swift) 
|  |  |  
|  |  |- assignments //(#assignment subrepository)
|  |  |  |+ README.md //(#dialy-assignment-readme)
|  | 
|  . 
|  .
|
|- (2nd-8th)-week
|  |
|  |// same as 1st week

• README.md files are in all caps so they appear fist alphabeticly (show up first in $ ls)
• weekly-directorys start with 1st, 2nd, ect. so they appear in order for $ ls
• daily-directorys are name (month)-(day)-(topic-covered) oct-23-structs-and-classe

course readme

• course title
• panel name + ios | python | ruby | javascript sea-d49-ios
• assignment links: links to daily assignment subrepositorys
• video links: links to daily youtube uploads

weekly directory

• readme, daily directorys
• if the lecture code expands on a previous day recursivly copy the previous day's directory

weekly readme

• topics of the week
• list of links to daily assignment subrepositorys
• list of links to daily youtube video uploads

dialy directory

• readme, lecture-code directory, assignments directory

daily readme

• list of topics covered
• list of links to daily youtube video uploads

daily lecture code readme

(optional)

• instructions on how to run the daily lecture code

assignment sub-repository

• a sub-repository for students to make pull request to

daily assignment readme

• instructions for the homework
• links to articles