DPS909 & OSD600 Fall 2018

Week 1

• Course introduction
  • DPS909
  • OSD600
  • How to be successful in this course

• Releases
  • 4 releases, some with multiple bugs/PRs required
  • Chance to work on real code, real projects
  • Big learning curve, lots of time required
  • Amazing chance to gain experience, network, build your skills and resume

• Discussion/Readings
  • Copyright (Copyright in Canada video)
    • IANAL
    • Who created it, "owns" it.
    • Set of exclusive rights granted to the work's creator
    • "The right to copy," to produce or reproduce a work or substantial portion thereof
    • Copyright is automatic when a work is created, you don't have to register it.
    • Copyright in Canada
    • Copyright Guide
    • In a software project, there can be many copyright holders (e.g., many contributors), or all contributors may assign their copyright to the project (e.g., CLA, which we'll cover later)
  • What is Open Source?
    • The Open Source Definition
  • Microsoft buys GitHub for 7.5 Billion - "We're all in on open source"
  • Julia Evans, "How to teach yourself hard things"

• Slack
  • https://seneca-open-source.slack.com
  • Slack, Getting Started
  • Tour the Slack app

• First open technologies and projects we'll be using:
  • node.js
  • node fs module docs
  • filer
  • mocha

Week 2

• Release 0.1 Overview
  • Due Friday Sept 28th
  • node.js
  • node fs module vs. filer
  • synchronous vs. asynchronous functions in JavaScript
  • node's callback function pattern vs. Promises

• Licenses
  • Rights, privileges, responsibilities, etc. applicable to someone other than the work's creator
  • "Terms and Conditions"
  • These must be granted by a copyright holder

• No License
  • What can you do with code you find that has no license?
  • what can I, can't I do?

• Public Domain
  • SQLite, which is now used by literally everybody, see http://www.sqlite.org/famous.html
  • Unlicense

• BSD License
  • Family of Licenses, including 2-Clause BSD, 3-Clause BSD (aka New BDS), 4-Clause BSD
  • "Why you should use a BSD style license for your Open Source Project"
  • BSD Licenses code is usually compatible with other open/closed code, when you want to mix them.
  • Example software projects licensed under the BSD License:
    • Many Google Projects, including V8, Chromium, Go
    • D3.js
    • Django
    • nginx
    • Vi
    • Facebook uses a modified version of the 3-Clause BSD they call [BSD + Patents license]. This has been controversial
      • BSD + Patent
      • PATENTS in React
      • https://code.facebook.com/posts/112130496157735/explaining-react-s-license/
  • Summary:
    • You need to retain the license and copyright notice
    • You can use it commercially or non-commercially (privately)
    • You can distribute it freely
    • You can modify it freely

• Open Source and Code Reading
  • Deep Dive on the node fs module by Safia Abdalla
  • fs.truncate()
    • node.js source for truncate
    • Search results in nodejs/node's test/* directory for JavaScript files including 'truncate'
    • Code Coverage for fs.truncate
    • Filer source for truncate
    • Filer tests for truncate

• Lab 1

Week 3

• Consider Speaking and/or Attending the Free Software and Open Source Symposium (FSOSS).

• Introducing git and GitHub

• Readings/Resources
  • Courses on Lynda
    • Git Essential Training
    • Up and Running with Git and GitHub
  • Books
    • Pro Git
    • Version Control by Example, online book
  • References
    • Git Reference
    • Visual Git Reference
    • Overview of Git Tutorials (many good ones)
    • Github documentation
    • GitHub Desktop

• Filing and Fixing a bug: a cookbook approach
  • set up git and GitHub
    • https://help.github.com/ has lots of great articles to help you. You can also view video guides or read the printed guides
    • setup your username in git
    • setup your email address in git
    • specify which editor git should use, for example you can use vscode
    • setup line endings (CRLF vs. LF) in git
    • setup ssh keys for GitHub
  • In GitHub, create a fork of the repo you want to work on
  • On your computer, clone your forked repo
  • On your computer, add a remote named "upstream" for the original repo (vs. your fork)
  • On GitHub, find or create an Issue for the change you want to make
  • On your computer, create and checkout a branch for your work, e.g., issue-1234 for Issue #1234
  • On your computer, make code changes, test them, add, and commit on your branch. Repeat as necessary.
  • On your computer, push your changes (commits) to your fork (origin)
  • On GitHub, create a Pull Request for your changes to get sent to the upstream repo
  • On your computer, fix any problems pointed out by your reviewer(s), add the file(s), commit, and push again to update your pull request

• Real world examples:
  • Filing, Fixing a bug in Filer
  • Adding a new Feature, Tests, and Docs to Filer - support node's new recursive fs.mkdir in Filer

• Lab 2

Week 4

• Learning Licenses: MIT
  • MIT License
  • The MIT License, Line by Line
  • One of the most widely used licenses in Open Source
  • Like the BSD License, nothing about patents (created before software was patentable in the US)
  • Example software projects licensed under the BSD License:
    • ExpressJS
    • Ruby on Rails
    • AngularJS
    • Atom, Electron
    • Bootstrap
    • node.js
    • Phaser
    • PuTTY
    • Socket.IO

• More Git
  • Git Walkthrough Part I
  • Git Walkthrough Part II
  • Some basic git commands you should make sure you know how to use:
    • git clone - clone an existing repository (i.e., one you've forked on GitHub)
    • git status - check what's happening with your repo, working directory, branch info
    • git add - add a file, files, or folder(s) of file(s)
    • git commit - commit changes in the staging area
    • git log - look back at existing commits
    • git diff - look at the difference between what's in the working directory and staging area, or between two commits
    • git rm - remove a file
    • git mv - move or rename a file
    • git reset - update the staging area, and perhaps working directory, with files from another commit (e.g., HEAD)
    • git checkout - switch to a branch or commit, or create, or get files from a branch/commit

Week 5

• Release 0.2: Hacktoberfest
  • For Tuesday October 9th (Lab 3)
    • First (of 5) PR completed with a Blog Post
    • Submit via https://github.com/humphd/hacktoberfest-at-seneca-2018/wiki/Student-Submissions
  • Add projects that you think are good for other students to https://github.com/humphd/hacktoberfest-at-seneca-2018/wiki/Interesting-Open-Source-Projects

• Merging with git
  • Where git branch splits histories apart, git merge brings them back together
  • Understanding DIFFs and Patch files
    • git diff, git show, git log -p, etc. to show DIFFs
    • Pull Requests also have links to get the raw .diff and .patch
    • How to read a DIFF file
  • Types of Merges: Fast Forward, Recursive Merges are the most common
    • --ff-only to force a fast-forward (only the branch pointer is moved, no new commit is created)
    • 3-way merges: two branch commits with a common ancestor (new commit is created with multiple parents)
    • Can have any number of parents though: one of the larges is a 66 commit octopus merge in the Linux kernel
  • How to merge
    • start with a clean working directory
      • commit your work if you can; or
      • stash (git stash list, git stash show, git stash pop)
    • checkout the branch you want to merge into
    • git merge branch_to_merge_into_this_branch
  • Various flags and commands to know:
    • git merge --squash
    • git merge --abort
    • git merge --continue
    • git branch -d
  • Merge Conflicts
    • Conflict markers <<<<<<<<<, =============, >>>>>>>>>>>>
  • Doing big merges in git

Week 6

• Hacktoberfest Updates
  • Add any interesting projects you find/work on to this list on the wiki
  • Update your Info on the submissions wiki page by Monday:
    • Add your Name beside your GitHub username
    • New Pull Request
    • New Blog Post
    • Any Issues you're working on
  • Week 1 Summary

• git rebase branch
  • Replay commits on a new base branch/commit
  • Process goes like this:
    • git finds a common ancestor commit of the branch you're on, and the one you're rebasing onto
    • git calculates DIFFs for each, saves them to disk
    • git checks out the commit you want to branch onto, and begins to replay those diffs one by one
    • if there is a merge conflict, the rebase pauses so you can fix things
    • use git rebase --continue or git rebase --abort to move forward after such a pause
    • use git rebase --skip to ignore the current commit and keep going
  • Never rebase commits that are shared publicly in another repo. Only do it on commits you own locally (e.g., a topic branch you are working on)
  • Don't use rebase to get rid of commits in a public branch, use git revert commit-sha instead to apply an inverse commit
  • If you rebase a branch you've pushed (e.g., for a pull request), when you push, use git push origin branch-name -f (f means force and will overwrite)
  • git rebase -i for interactive rebase
    • shows a script of all commits in reverse order (order they will be replayed). You can hand edit this to remove, re-order, or combine commits
  • You can squash on the same branch by rebasing on HEAD~n where n is how many commits back from HEAD to go

• PRs needing a Rebase
  • https://github.com/filerjs/filer/pull/496
  • https://github.com/filerjs/filer/pull/437
  • https://github.com/filerjs/filer/pull/439
  • https://github.com/filerjs/filer/pull/468
  • https://github.com/filerjs/filer/pull/545

Week 7

• GitHub 2018 Summary

• Hacktoberfest Week 2
  • Update your Info on the submissions wiki page by Monday:
    • Add your Name beside your GitHub username
    • New Pull Request
    • New Blog Post
    • Any Issues you're working on

• Rebase Review and Demo

• Open Source Case Study: Visual Studio Code
  • https://code.visualstudio.com/
  • https://github.com/Microsoft/vscode
  • https://en.wikipedia.org/wiki/Visual_Studio_Code
  • Technologies
    • Electron
    • Monaco Editor
    • TypeScript
    • xterm.js
    • node.js, express, and hundreds of JavaScript modules

• Fixing Bugs in VSCode
  • UI Bugs:
    • https://github.com/humphd/vscode/tree/good-first-experience-issue-42726#walkthrough-fixing-a-bug-in-visual-studio-code
    • URL Link Bug: https://github.com/Microsoft/vscode/issues/45515
  • Crash Bugs:
    • https://github.com/Microsoft/vscode/issues/47548
    • https://github.com/Microsoft/vscode/issues/49547
  • Localization Bug: https://github.com/Microsoft/vscode/issues/49211

Week 8

• Hacktoberfest 0.2 Due this Week (Wed Oct 31)
  • Finish all 5 Pull Requests + Blog Posts
  • Write a 6th and final Blog Post about all of your contributions. Include links to the Bugs you fixed and Pull Requests. Talk about what you learned, your growth through the experience, what went well, what you would do differently next time, and your reflections on Hacktoberfest in general.
  • Make sure all PRs and Blog Posts (including 6th conclusion post) are up at https://github.com/humphd/hacktoberfest-at-seneca-2018/wiki/Student-Submissions

• 0.3 and 0.4 Releases, Labs 5-10
  • Complete 3 larger PRs in external open source projects + 3 PRs in internal OSD/DPS open source run projects
  • For 0.3, follow a 2 + 1 pattern: either 2 external and 1 internal, or 2 internal and 1 external.
  • For 0.4, follow a 1 + 2 pattern: do the opposite of what you did in 0.3
  • Consider working on a project you began working with during Hacktoberfest, though you aren't limited to this.
  • PRs for 0.3 and 0.4 are about increasing quality vs quantity. You need to work on larger fixes/features than many of you did for Hacktoberfest. If you want to work on small bugs, you'll need to combine them together.
  • Each Monday, a blog post discussing your work from the previous week is due. Link to bugs you are working on, PRs or branches in progress, talk about what you learned, what you're still thinking about, and any plans you have for upcoming weeks.
  • You do not need to complete a PR every week for 0.3 and 0.4; though you will need to make progress each week in order to blog, and to stay on track.

• OSD/DPS Open Source Projects
  • Gain some experience being on the other side of a Pull Request: what's it like, and what's involved in building and maintain an open source project?
  • Do any students already have open source projects others could join?
  • What are some projects we should consider starting together?
  • Most popular internal project ideas:
    • (NEW) DarkChatter - decentralized direct networking/messaging over low-level WiFi packets (15 ✔️)
    • (NEW) Browser Extension to control how Blackboard, Seneca Student Centre, and other Seneca web properties look and feel using GreaseMonkey. Fix student issues in the UI (14 ✔️)
    • (NEW) Speech-To-Text coding for HTML templating - code with your voice, plugin for VSCode or similar (14 ✔️)
    • (NEW) Turn-based creative writing app for friends to write fiction together in a fun way (web/texting interfaces) (13 ✔️)
    • (NEW) GitHub Dashboard - track status of things you've worked on, track projects you want to try next (10 ✔️)
    • (EXISTING) Node.js/React chat project; ideally standalone and published on npm (10 ✔️)
    • (EXISTING) Unity side-scrolling video game in C# (9 ✔️)
    • (EXISTING) App to aggregate and download starred GitHub projects (9 ✔️)
    • (NEW) Resume/Portfolio generator: simple static site generation for non-technical students (9 ✔️)
  • Other ideas presented:
    • (NEW) Open Source Dwarf Fortress clone: ASCII style game (8 ✔️)
    • (NEW) RSS bot for when wiki's are updated (7 ✔️)
    • (NEW) Browser extension for remembering where you left off & resume YouTube videos (7 ✔️)
    • (NEW) YouTube bulk downloader using youtube-dl (provide a list of links to videos to download) (6 ✔️)
    • (NEW) Social Media Dashboard - see analytics from multiple social media platforms (5 ✔️)
    • (NEW) Web bot detector/blocker (4 ✔️)
    • (EXISTING) Cross platform command-line utility for searching Amazon, Google, StackOverflow etc in your browser (2 ✔️)
    • (NEW) Test wrapper script for running tests from different frameworks (1 ✔️)
    • (EXISTING) My Little Pony search GUI for data and analytics of existing, large fan fiction database; built with Java Swing (1 ✔️)
    • (NEW) Text diff tool for dealing with non line-based changes (1 ✔️)

• Open Source Case Study: Redis
  • Redis (REmote DIctionary Server)
  • https://github.com/antirez/redis - ~175K lines of code
  • Cross-platform, high performance, in-memory, key/value, data structure database server. Written in mostly in C, as well as Tcl and Lua, with front-ends in just about every language and platform.
  • BSD 3-Clause
  • Started in 2009 by Salvatore Sanfilippo (antirez)
  • Since 2015, development has been sponsored by Redis Labs (see https://en.wikipedia.org/wiki/Redis_Labs)
  • Redis is among the most popular NoSQL databases in the world, and the most popular key/value store. It is used by everyone:
    • Twitter
    • Instagram
    • GitHub
    • StackOverflow
    • Pinterest
    • Snapchat
    • Shopify
    • AirBnB
    • Uber
    • Tumblr
    • Slack
    • Medium
    • Imgur
    • Kickstarter
  • Common Use Cases:
    • User Session Cache (e.g., reduce DB lookups for user info, shopping cart data)
    • Full Page Cache (e.g., by URL or route)
    • Queues (e.g., Message Queue, Worker Queue)
    • Counting (e.g., metrics, analytics)
    • Pub/Sub (e.g., chat systems, notifications)
  • Redis Tutorial and Walkthrough: https://try.redis.io/