Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 2.49 KB

prereq_overview.md

File metadata and controls

56 lines (32 loc) · 2.49 KB

Course Overview and Preparation

Time-box

N/A: the steps in this section should ideally be completed by the instructor and/or the participants prior to arrival at the workshop.

Overview

Welcome to the Introduction to Open Source Workshop. Participants are expected to walk away with enough knowledge to be able to participate in a typical open source project. The workshop has a mixture of hands-on and lecture/demo, with the focus on hands-on.

What to expect

This workshop covers...

  • Environment Setup: Installing software, creating a virtual environment, forking a repository and setting up version control software.
  • Using Git: basic commands to copy a repository, add your changes, commit those changes and push the changes to Github.
  • Using Github: basic overview of the collaborative tools on Github and how to issue a pull request.
  • Practicing your skills: A chance to practice these skills on a project on Github.

What not to expect

This workshop does not cover...

  • How to program
  • Programming in any specific language

This is not a programming workshop, nor is it a Python workshop. It is intended to prep students to contribute to open source projects, it is not intended to teach students how to program.

The example code in this version of the workshop is written in Python, but this project can be run using an example project in another programming language, if desired.

Learning objectives

Participants should expect to achieve the following learning objectives upon completing this workshop:

  • Be able to install the following software: conda, git, etc
  • Be able to create a virtual environment
  • Be able to use git and github to create a copy of an open source project on their own computer
  • Upon editing, adding, or deleting content in a project:
    • incorporate any changes to the project, made by others, into their own local copy
    • correct any conflicts between their changes and other's changes
    • successfully issue a request for their contribution to be added to the open source project

Preparatory Lessons

Previous Up Next
Table of Contents Instructor Preparation