Skip to content
This repository has been archived by the owner on Apr 19, 2021. It is now read-only.

This is a friendly introduction to making open, version-controlled, and collaborative projects using Github.

License

Notifications You must be signed in to change notification settings

joeyklee/friendly-github-intro

Repository files navigation

❤️


We have a living Etherpad for the workshop here - Github Workshop, March 8th, 2016.


A Friendly Github Introduction

This is a friendly introduction to making open, version-controlled, and collaborative projects using Github.

You are invited to fork this repo and use our materials-- please let us know what you do with them and how it goes!

About

This is a friendly introduction to Github – a free and open source platform that can help you build projects that are collaborative, well documented, and version-controlled. In this workshop we will introduce you to the Github ecosystem and help you get you comfortable navigating basic Github workflows. We will make sure that you leave the workshop aware of the best practices for developing projects on Github (e.g. writing a good “readme” or posting and labeling issues) and an understanding of how Github can help make your projects more readable and accessible. This workshop is developed for anyone looking for a solution to making projects – whether it be your research on arctic glaciers, the materials for an undergraduate course, your PHD thesis, or even a cookbook – more manageable. This workshop is geared towards all skill levels, but first-time and novice users are encouraged and prioritized.

Learning Objectives & Takeaways

At the end of the workshop, we hope you will feel acquainted and/or comfortable with:

  • Github as:
    • social platform - collaboration, coordination, and contributing
    • Time machine - track project and go back
    • documentation & sharing platform
    • project development platform
  • Basic Github Workflows:
    • working individually with commits, issues, branching, and merging
    • working collaboratively with issues, forking & pull requests

Why are we teaching GitHub?

Git/GitHub can enable projects of any size (from individuals up to organizations and companies) to develop in a way that is well managed, readable, and many cases, accessible and open source. GitHub is allowing professors to share their course materials online, scientists to share their analyses and data, startups to build new technologies, and governments to share data - it is enhancing our ability to do work, better.

At the Mozilla Science Lab, we use GitHub as a platform to share knowledge, build communities, and make science as open and accessible as possible. We hope you will use GitHub as well to make better projects.

What is "open" research?

Whether you're studying the human genome, black holes, deep sea ecology, medieval music, or alternative energy sources, research is a practice and process of learning, and creating knowledge. Researchers always build on (or transform) an existing understanding of the world. A researcher working open shares insights or discoveries freely, makes her data available on the web, or makes the details of a new experimental technique or tool public so others can use and reuse it. By working open, she empowers fellow researchers and furthers our collective knowledge... knowledge that can be used to solve problems, save lives, and inspire and amaze us all. The more data, knowledge, methods, tools and skills made widely and openly available to all, the better.

Oh, by the way, what's Mozilla Science Lab??

At Mozilla Science Lab we help scientists and researchers (anyone from students to established researchers to citizen scientists) to work openly and do better research, more research, and make that research more useful by sharing it widely.

We provide various types of trainings (such as this Workshop), learning materials and formats (such as Mozilla Study Groups), platforms for sharing and showcasing open Science projects (such as MSL Collaborate), and support for leaders in open science (through the Mozilla Fellows for Science.

About

This is a friendly introduction to making open, version-controlled, and collaborative projects using Github.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published