diff --git a/LICENSE b/LICENSE index 9cf1062..9dccfa4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,19 +1,19 @@ -MIT License - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 966eaf4..19a72b0 100644 --- a/README.md +++ b/README.md @@ -1,114 +1,29 @@ -# Git and GitHub - -## Contents -* [Description](#description) -* [Learning Outcomes](#learning-outcomes) -* [Assignments](#assignments) -* [Contacts](#contacts) -* [Delivery of the Learning Module](#delivery-of-the-learning-module) -* [Schedule](#schedule) -* [Requirements](#requirements) -* [Resources](#resources) - + [Cheat sheet](#cheatsheet) - + [Videos](#videos) - + [How to get help](#how-to-get-help) -* [Folder Structure](#folder-structure) - -## Description - -This module explores version control with Git and GitHub, and how it connects to the ethical discussions of reproducibility. Participants will set up Git and create and use repositories, including recording, viewing and undoing changes. You will also learn how to create branches and collaborate with others with shared branches. This module also introduces more advanced commands such as de-bugging and history editing. - -Throughout the entire module, participants will learn how to problem solve through live coding. You will also learn about reproducibility and how to centre it within your work. - -## Learning Outcomes - -By the end of the module, participants will be able to: -* Use Git to collaboratively save, restore, and update work through version control -* Explain the difference between Git and GitHub - -## Assignments - -Participants should review the [Assignment Submission Guide](https://github.com/UofT-DSI/onboarding/blob/main/onboarding_documents/submissions.md) for instructions on how to complete assignments in this module. - - -1. [Git Assignment](https://github.com/UofT-DSI/git/blob/main/02_assignments/git_assignment.md) - - -## Contacts - -**Questions can be submitted to the _#cohort-3-help_ channel on Slack** - -* Technical Facilitator: - * **Simeon Wong** (he/him) - simeonm.wong@utoronto.ca - - * Learning Support Staff: - * **Michaela Drouillard** (she/her) - michaela.drouillard@mail.utoronto.ca - * **Julia Gallucci** (she/her) - julia.gallucci@mail.utoronto.ca - * **Emma Teng** - e.teng@mail.utoronto.ca - -## Delivery of the Learning Module - -This module will include live learning sessions and optional, asynchronous work periods. During live learning sessions, the Technical Facilitator will introduce and explain key concepts and demonstrate core skills. Learning is facilitated during this time. Before and after each live learning session, the instructional team will be available for questions related to the core concepts of the module. Optional work periods are to be used to seek help from peers, the Learning Support team, and to work through the homework and assignments in the learning module, with access to live help. Content is not facilitated, but rather this time should be driven by participants. We encourage participants to come to these work periods with questions and problems to work through. - -Participants are encouraged to engage actively during the learning module. They key to developing the core skills in each learning module is through practice. The more participants engage in coding along with the instructional team, and applying the skills in each module, the more likely it is that these skills will solidify. - -## Schedule - -The schedule is tentative and may be modified as needed. Learners will be notified of schedule changes. - -||Day 1|Day 2|Day 3|Day 4|Day 5| -|---|---|---|---|---|---| -|Week 1|Live Learning Session 1 ([Shell](https://github.com/UofT-DSI/shell))|Live Learning Session 2 (Shell)|Live Learning Session 3 (Git & Github)|Work Period 1|Work Period 2| - -## Requirements - -* Participants are not expected to have any coding experience; the learning content has been designed for beginners. -* Participants are encouraged to ask questions, and collaborate with others to enhance their learning experience. -* Participants must have a computer and an internet connection to participate in online activities. -* Participants must not use generative AI such as ChatGPT to generate code in order to complete assignments. It should be used as a supportive tool to seek out answers to questions you may have. -* We expect learners to have completed the [onboarding repo](https://github.com/UofT-DSI/onboarding/tree/main/onboarding_documents). -* We encourage participants to default to having their camera on at all times, and turning the camera off only as needed. This will greatly enhance the learning experience for all participants and provides real-time feedback for the instructional team. - -## Resources - -Feel free to use the following as resources: - -### Cheat sheet - -- [Atlassian](https://www.atlassian.com/git/tutorials/atlassian-git-cheatsheet) -- [GitHub](https://education.github.com/git-cheat-sheet-education.pdf) - -### Videos -- [Most common git commands](https://www.youtube.com/watch?v=PSJ63LULKHA) -- [Git explained in 100 seconds](https://www.youtube.com/watch?v=hwP7WQkmECE) -- [Git vs GitHub: What's the difference?](https://www.youtube.com/watch?v=wpISo9TNjfU) - -### How to get help - -![image](./steps_to_ask_for_help.png) - -