Difference between revisions of "DPS909 & OSD600 Winter 2019"

From CDOT Wiki
Jump to: navigation, search
(→‎Week 12)
 
(19 intermediate revisions by the same user not shown)
Line 180: Line 180:
 
== Week 5 ==
 
== Week 5 ==
  
 +
* Finish Lab 3, [https://blog.humphd.org/browsing-open-source-projects/ Example: 3 projects I found recently]
 +
** Also, see [https://docs.brew.sh/Linuxbrew Linuxbrew for Windows 10]
 
* [[OSD & DPS909 Winter 2019 Release 0.2|Release 0.2]]
 
* [[OSD & DPS909 Winter 2019 Release 0.2|Release 0.2]]
 
** Lab 4 - first PR and Status update blog post (Friday Feb 15)
 
** Lab 4 - first PR and Status update blog post (Friday Feb 15)
Line 207: Line 209:
 
*** Conflict markers <code><<<<<<<<<</code>, <code>=============</code>, <code>>>>>>>>>>>>></code>
 
*** Conflict markers <code><<<<<<<<<</code>, <code>=============</code>, <code>>>>>>>>>>>>></code>
 
** [https://blog.humphd.org/fearless-merges/ Doing big merges in git]
 
** [https://blog.humphd.org/fearless-merges/ Doing big merges in git]
 +
 +
== Week 6 ==
 +
 +
* 0.2 Updates
 +
** Interesting projects you've found?
 +
** https://codetribute.mozilla.org/
 +
** Update your Info on the 0.2 wiki with status blog post, PR(s)
 +
 +
* <code>git rebase branch</code>
 +
** 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 <code>git rebase --continue</code> or <code>git rebase --abort</code> to move forward after such a pause
 +
*** use <code>git rebase --skip</code> 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 <code>git revert commit-sha</code> instead to apply an inverse commit
 +
** If you rebase a branch you've pushed (e.g., for a pull request), when you push, use <code>git push origin branch-name -f</code> (f means force and will overwrite)
 +
** <code>git rebase -i</code> 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 <code>HEAD~n</code> where n is how many commits back from HEAD to go
 +
* <code>git cherry-pick SHA</code> to add a commit to the current branch
 +
 +
== Week 7 ==
 +
 +
* Continue working on 0.2
 +
** Discussion of any issues/questions you have
 +
** Update blog post #2 due on Friday
 +
** 2 Weeks left, you should have ~2 PRs done by Friday to stay on track
 +
 +
* Rebase and Merge Demo
 +
** Upstream: https://github.com/copy/v86 (24 commits ahead)
 +
** Forked: https://github.com/humphd/v86/tree/filer-9p-lastknowngood (33 commits ahead)
 +
** Last common commit: https://github.com/copy/v86/commit/f6ae3ea58aee15f2a9be71f2847738367ef31747
 +
 +
* 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
 +
*** [https://electronjs.org/ Electron]
 +
*** [https://microsoft.github.io/monaco-editor/ Monaco Editor]
 +
*** [https://www.typescriptlang.org/ TypeScript]
 +
*** [https://xtermjs.org/ 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 ==
 +
 +
* Finish and Submit 0.2
 +
** Take some time to read your colleague's reflection posts, some examples:
 +
** [https://jatinkumar.home.blog/2019/03/05/open-source-contribution-summary-feb-edition/ Jatin]
 +
** [https://woosleparkdpd909.wordpress.com/2019/03/06/release-0-2-final-submission/ Woosle]
 +
** [https://olenavyshnevska.blogspot.com/2019/03/final-summary-blog-post.html Olena]
 +
 +
* Bug Fix Case Study and Walkthrough
 +
** [https://desktop.github.com/ GitHub Desktop]: MIT licensed, Electron app written in TypeScript and React for working with git/GitHub
 +
** [https://github.com/desktop/desktop GitHub Desktop Repository]
 +
** [https://github.com/desktop/desktop/issues/6390 Issue 6390]
 +
** [https://github.com/humphd/desktop/tree/good-first-experience-issue-6390#walkthrough-fixing-a-bug-in-github-desktop Walkthrough of Fixing Bug 6390]
 +
 +
== Week 9 ==
 +
 +
* Releases 0.3 and 0.4
 +
** [[DPS909/OSD600 Winter 2019 Lab 8|Lab 8]] due Fri, Mar 15
 +
** [[OSD & DPS909 Winter 2019 Release 0.3|Release 0.3]] due Fri, Mar 29
 +
** [[OSD & DPS909 Winter 2019 Release 0.4|Release 0.4]] due Fri, Apr 12
 +
 +
* Open Source Case Study: Redis
 +
** [https://redis.io/ Redis (REmote DIctionary Server)]
 +
** https://github.com/antirez/redis - [https://www.openhub.net/p/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.
 +
** [https://github.com/antirez/redis/blob/unstable/COPYING BSD 3-Clause]
 +
** Started in 2009 by [https://github.com/antirez 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/
 +
* [http://antirez.com/news/124 Writing Code Comments] based on [https://github.com/antirez/redis/tree/32e0d2376fe91e76be04bb62825af5d95737b13e 32e0d237 commit]
 +
* His [https://www.youtube.com/channel/UCDDG9vOcmgwlslJJpCWjqOg YouTube channel] has more video discussions of the code in Redis
 +
 +
== Week 10 ==
 +
 +
* Starting a new Open Source Project: [https://github.com/humphd/browser-mime browser-mime]
 +
** The problem: https://github.com/humphd/nohost/issues/6
 +
** [https://www.npmjs.com/package/mime-db mime-db]
 +
** [https://www.npmjs.com/package/mime-types mime-types]
 +
** Discussion
 +
*** [https://twitter.com/jalbertbowdenii/status/1106224172781457411 talk to the community]
 +
*** https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigationTiming
 +
*** [https://gist.github.com/humphd/a4458bc2895844c6cb756ae5e3074f66 research data]
 +
*** [https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS CORS and Data URIs (we need a small server for same-origin analysis)]
 +
*** [https://pptr.dev/ Puppeteer for automation]
 +
*** How to modify [https://github.com/jshttp/mime-types/blob/master/index.js mime-types code] to use our new db? [https://www.atlassian.com/blog/git/git-submodules-workflows-tips Git Submodule] vs [https://www.atlassian.com/blog/git/alternatives-to-git-submodule-git-subtree Git Subtree]
 +
**** <code>git submodule add https://github.com/jshttp/mime-types.git</code> to create and <code>git submodule update --remote</code> to update
 +
**** <code>git subtree add --prefix mime-types https://github.com/jshttp/mime-types.git master --squash</code> to create and <code>git subtree pull --prefix mime-types https://github.com/jshttp/mime-types.git master --squash</code>
 +
 +
* [https://humphd.github.io/pretty-effective/ Case Study - Prettier]
 +
** Web site: https://prettier.io/
 +
** Twitter: https://twitter.com/PrettierCode
 +
** GitHub: https://github.com/prettier/prettier
 +
** [https://www.youtube.com/watch?v=hkfBvpEfWdA  James Long introducing Prettier (video)]
 +
** [https://www.youtube.com/watch?v=3p6XR2VeHRw Visualization of Prettier Development (video)]
 +
 +
* Using linting and pretty-printing tools in projects
 +
** [https://prettier.io/docs/en/install.html Installing Prettier]
 +
** [https://eslint.org/ eslint]
 +
 +
* Work on your Release 0.3
 +
 +
== Week 11 ==
 +
 +
* Complete your 0.3 and begin/continue 0.4
 +
 +
* Continuous Integration (CI)
 +
** Lots of free-for-open-source CI services: [https://travis-ci.com/ TravisCI], [https://azure.microsoft.com/en-ca/services/devops/pipelines/ Azure Pipelines], [https://circleci.com/ CircleCI], [https://www.appveyor.com/ AppVeyor], [https://jenkins.io/ Jenkins]
 +
 +
* Automating build, test, and deploy steps with Travis CI
 +
** https://docs.travis-ci.com/
 +
** https://docs.travis-ci.com/user/for-beginners/
 +
 +
* Travis uses YAML for configuration
 +
** YAML Ain't Markup Language (YAML)
 +
** https://en.wikipedia.org/wiki/YAML
 +
** Usually uses the .yml extension
 +
** https://learnxinyminutes.com/docs/yaml/
 +
 +
* Stages of a Travis CI Build
 +
** [https://docs.travis-ci.com/user/job-lifecycle/#the-job-lifecycle Stages of Build Lifecycle]
 +
** Adding OS-level dependencies https://docs.travis-ci.com/user/installing-dependencies/
 +
 +
* Running Tests per Commit/PR
 +
** https://docs.travis-ci.com/user/languages/javascript-with-nodejs/
 +
** Assumes you want to `npm install` and run `npm test`
 +
** Therefore, you need a working install and test process via `package.json`
 +
 +
* Deployment options:
 +
** GitHub and gh-pages
 +
*** https://pages.github.com/
 +
*** https://help.github.com/categories/github-pages-basics/
 +
*** Enable HTTPS https://help.github.com/articles/securing-your-github-pages-site-with-https/
 +
*** Custom 404 page https://help.github.com/articles/creating-a-custom-404-page-for-your-github-pages-site/
 +
*** https://docs.travis-ci.com/user/deployment/pages/
 +
*** https://docs.travis-ci.com/user/status-images/
 +
** [https://docs.travis-ci.com/user/deployment/cargo/ Deploy Rust crates to Cargo]
 +
** [https://docs.travis-ci.com/user/deployment/releases/ Deploy binary releases to GitHub Releases]
 +
** [https://docs.travis-ci.com/user/deployment/heroku/ Deploy web apps to Heroku]
 +
** [https://docs.travis-ci.com/user/deployment/npm/ Deploy node modules to npm]
 +
** [https://docs.travis-ci.com/user/deployment/pypi/ Deploy python packages to PyPi]
 +
 +
* Some example .travis.yml files in OSS projects
 +
** https://github.com/filerjs/filer/blob/master/.travis.yml
 +
** https://github.com/devtools-html/debugger.html/blob/master/.travis.yml
 +
** https://github.com/datalocale/dataviz-finances-gironde/blob/master/.travis.yml
 +
 +
* [https://github.com/humphd/learn-travis Walkthrough: setting up Travis for a node.js app]
 +
 +
== Week 12 ==
 +
 +
* Discussion of open source maintenance, maintainers, and our expectations of "free" software
 +
 +
* BDFL
 +
** Linux: https://www.linuxjournal.com/content/25-years-later-interview-linus-torvalds
 +
** Python: https://lwn.net/Articles/759654/, https://www.theregister.co.uk/2018/07/13/python_creator_guido_van_rossum_quits/
 +
** Node modules: https://www.npmjs.com/package/request, https://github.com/request/request/issues/3142
 +
 +
** event-stream hack
 +
*** https://twitter.com/garybernhardt/status/1067111872225136640
 +
*** https://github.com/dominictarr/event-stream/issues/116
 +
*** https://schneid.io/blog/event-stream-vulnerability-explained/ Hack explained
 +
*** https://blog.npmjs.org/post/180565383195/details-about-the-event-stream-incident
 +
*** https://blog.tidelift.com/event-stream-100-million-downloads-unmaintained-hacked.-now-can-we-pay-the-maintainers
 +
 +
** Emerging models
 +
** https://opencollective.com/, e.g., https://opencollective.com/babel
 +
** https://tidelift.com/
 +
** https://www.patreon.com/, e.g., https://www.patreon.com/henryzhu, https://www.patreon.com/sindresorhus
 +
** LTS for Node Modules - https://medium.com/@nodejs/call-to-action-accelerating-node-js-growth-e4862bee2919
 +
*** https://github.com/nodejs/package-maintenance

Latest revision as of 08:18, 3 April 2019

Week 1

  • Course introduction

Week 2

  • 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

Week 3

Week 4

  • More Git
    • Understanding how git works
      • SHAs
      • commits, trees, blobs
      • branches
      • Working Directory vs. Staging Area vs. HEAD
    • 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

  • Merging with git
    • Where git branch splits histories apart, git merge brings them back together
    • Understanding DIFFs and Patch files
    • 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

  • 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
  • git cherry-pick SHA to add a commit to the current branch

Week 7

  • Continue working on 0.2
    • Discussion of any issues/questions you have
    • Update blog post #2 due on Friday
    • 2 Weeks left, you should have ~2 PRs done by Friday to stay on track

Week 8

  • Finish and Submit 0.2
    • Take some time to read your colleague's reflection posts, some examples:
    • Jatin
    • Woosle
    • Olena

Week 9

Week 10

  • Work on your Release 0.3

Week 11

  • Complete your 0.3 and begin/continue 0.4

Week 12

  • Discussion of open source maintenance, maintainers, and our expectations of "free" software
Retrieved from "https://wiki.cdot.senecapolytechnic.ca/w/index.php?title=DPS909_%26_OSD600_Winter_2019&oldid=138734"