667
edits
Changes
→Week 12
* Open Source and Code Reading
** [https:truncate*** <code>echo "data" > file</code>*** <code>> file</blog.safia.rocks/post/169466425525/node-module-deep-dive-fs Deep Dive on the node fs module] by [https://blog.safia.rocks/ Safia Abdalla]code>
** <code>fs.truncate()</code>
*** [https://nodejs.org/api/fs.html#fs_fs_truncate_path_len_callback docs]*** [https://github.com/nodejs/node/blob/8a86d9c1cf35fe4f892d483e3673083f5d8f42cf6b7b8276d196ea5a0e6dcee4e63c548b7938e8f4/lib/fs.js node#L618 JS src]*** [http://docs.libuv.org/en/v1.x/fs.js source for html?highlight=truncate#c.uv_fs_ftruncate libuv docs]*** [https://github.com/search?q=truncate+repo%3Anodejs%2Fnode+path%3A%2Ftest+language%3AJavaScript+language%3AJavaScript&type=Code Search results in nodejs/node's test/blob/8a86d9c1cf35fe4f892d483e3673083f5d8f42cf/deps/uv/src/unix/fs.c#L1229 POSIX C src]** directory for JavaScript files including '** Uses [http://man7.org/linux/man-pages/man2/truncate'.2.html ftruncate() system call]*** [https://coveragegithub.com/nodejs.org/coverage-3bdc61d4d194e205node/blob/8a86d9c1cf35fe4f892d483e3673083f5d8f42cf/deps/uv/src/rootwin/fs.jsc#L2318 Windows C src]**** Uses [https://docs.html#L612 Code Coverage for fsmicrosoft.truncatecom/en-us/windows-hardware/drivers/ddi/content/ntifs/nf-ntifs-ntsetinformationfile NtSetInformationFile() system call]*** [https://github.com/filerjs/filer/blob/master/src/filesystem/implementation.js#L2353 L2375 Filer source for truncate]*** A great blog doing something similar: [https://githubblog.safia.comrocks/filerjspost/filer169466425525/blob/masternode-module-deep-dive-fs Deep Dive on the node fs module and fs.access()] by [https:/tests/spec/fsblog.truncatesafia.spec.js Filer tests for truncaterocks/ Safia Abdalla]
* [[DPS909/OSD600 Winter 2019 Lab 1|Lab 1]]
== Week 3 ==
* '''Introducing [http://git-scm.com/ git] and [https://github.com/ GitHub]'''
* '''Readings/Resources'''
** Courses on [http://www.senecacollege.ca/lynda/ Lynda]
*** [https://www.lynda.com/Git-tutorials/Git-Essential-Training/100222-2.html?srchtrk=index%3a0%0alinktypeid%3a2%0aq%3agit%0apage%3a1%0as%3arelevance%0asa%3atrue%0aproducttypeid%3a2 Git Essential Training]
*** [https://www.lynda.com/Git-tutorials/Up-Running-Git-GitHub/409275-2.html?srchtrk=index%3a0%0alinktypeid%3a2%0aq%3agit%0apage%3a1%0as%3arelevance%0asa%3atrue%0aproducttypeid%3a2 Up and Running with Git and GitHub]
** Books
*** [http://git-scm.com/book Pro Git]
*** [http://www.ericsink.com/vcbe/index.html Version Control by Example, online book]
** References
*** [http://gitref.org/ Git Reference]
*** [http://marklodato.github.com/visual-git-guide/index-en.html Visual Git Reference]
*** [http://sixrevisions.com/resources/git-tutorials-beginners/ Overview of Git Tutorials (many good ones)]
*** [http://help.github.com/ Github documentation]
*** [https://desktop.github.com/ GitHub Desktop]
* Filing and Fixing a bug: a cookbook approach
** [https://help.github.com/articles/set-up-git/ set up git and GitHub]
*** https://help.github.com/ has lots of great articles to help you. You can also view [https://www.youtube.com/githubguides video guides] or read the [https://guides.github.com/ printed guides]
*** [https://help.github.com/articles/setting-your-username-in-git/ setup your username in git]
*** [https://help.github.com/articles/setting-your-commit-email-address-in-git/ setup your email address in git]
*** [https://help.github.com/articles/associating-text-editors-with-git/ specify which editor git should use], for example [https://stackoverflow.com/questions/30024353/how-to-use-visual-studio-code-as-default-editor-for-git?answertab=active#tab-top you can use vscode]
*** [https://help.github.com/articles/dealing-with-line-endings/ setup line endings (CRLF vs. LF) in git], [https://www.edwardthomson.com/blog/git_for_windows_line_endings.html extra notes for Windows users]
*** [https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/ setup ssh keys for GitHub]
** [https://help.github.com/articles/working-with-forks/ In GitHub, create a fork of the repo you want to work on]
** [https://help.github.com/articles/cloning-a-repository/ On your computer, clone your forked repo]
** [https://help.github.com/articles/adding-a-remote/ On your computer, add a remote named "upstream" for the original repo (vs. your fork)]
** [https://help.github.com/articles/creating-an-issue/ On GitHub, find or create an Issue for the change you want to make]
** [https://help.github.com/articles/about-branches/ On your computer, create and checkout a branch for your work, e.g., issue-1234 for Issue #1234]
** [https://www.atlassian.com/git/tutorials/saving-changes On your computer, make code changes, test them, add, and commit on your branch. Repeat as necessary.]
** [https://help.github.com/articles/pushing-to-a-remote/ On your computer, push your changes (commits) to your fork (origin)]
** [https://help.github.com/articles/creating-a-pull-request/ On GitHub, create a Pull Request for your changes to get sent to the upstream repo]
** [https://www.youtube.com/watch?v=e41HPOHX9aE 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 example, fixing a bug in Filer
** https://github.com/filerjs/filer/issues/628 - Add tests for fs.writeFile to increase coverage
* [[DPS909/OSD600 Winter 2019 Lab 2|Lab 2]]
== Week 4 ==
* Learning Licenses: MIT
** [https://choosealicense.com/licenses/mit/ MIT License]
** [https://writing.kemitchell.com/2016/09/21/MIT-License-Line-by-Line.html 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:
*** [https://expressjs.com/ ExpressJS]
*** [http://rubyonrails.org/ Ruby on Rails]
*** [https://angularjs.org/ AngularJS]
*** [https://atom.io/ Atom], [https://electron.atom.io/ Electron]
*** [http://getbootstrap.com/ Bootstrap]
*** [https://nodejs.org/ node.js]
*** [https://github.com/photonstorm/phaser Phaser]
*** [https://www.chiark.greenend.org.uk/~sgtatham/putty/ PuTTY]
*** [https://socket.io/ Socket.IO]
* More Git
** Understanding how git works
*** SHAs
*** commits, trees, blobs
*** branches
*** Working Directory vs. Staging Area vs. HEAD
** [https://wiki.cdot.senecacollege.ca/wiki/DPS909_%26_OSD600_Fall_2017_-_Git_Walkthrough Git Walkthrough Part I]
** [[DPS909 & OSD600 Winter 2017 - Git Walkthrough 2| Git Walkthrough Part II]]
** Some basic git commands you should make sure you know how to use:
***<code>git clone</code> - clone an existing repository (i.e., one you've forked on GitHub)
***<code>git status</code> - check what's happening with your repo, working directory, branch info
***<code>git add</code> - add a file, files, or folder(s) of file(s)
***<code>git commit</code> - commit changes in the staging area
***<code>git log</code> - look back at existing commits
***<code>git diff</code> - look at the difference between what's in the working directory and staging area, or between two commits
***<code>git rm</code> - remove a file
***<code>git mv</code> - move or rename a file
***<code>git reset</code> - update the staging area, and perhaps working directory, with files from another commit (e.g., HEAD)
***<code>git checkout</code> - switch to a branch or commit, or create, or get files from a branch/commit
* [[DPS909/OSD600 Winter 2019 Lab 3|Lab 3]]
== 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]]
** Lab 4 - first PR and Status update blog post (Friday Feb 15)
* Merging with git
** Where <code>git branch</code> splits histories apart, <code>git merge</code> brings them back together
** Understanding DIFFs and Patch files
*** <code>git diff</code>, <code>git show</code>, <code>git log -p</code>, etc. to show DIFFs
*** [https://github.com/filerjs/filer/pull/395 Pull Requests] also have links to get the raw [https://patch-diff.githubusercontent.com/raw/filerjs/filer/pull/395.diff .diff] and [https://patch-diff.githubusercontent.com/raw/filerjs/filer/pull/395.patch .patch]
*** [https://blog.humphd.org/vocamus-906/ How to read a DIFF file]
** Types of Merges: Fast Forward, Recursive Merges are the most common
*** <code>--ff-only</code> 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
**** <code>commit</code> your work if you can; or
**** <code>stash</code> (<code>git stash list</code>, <code>git stash show</code>, <code>git stash pop</code>)
*** checkout the branch you want to merge '''into'''
*** <code>git merge branch_to_merge_into_this_branch</code>
** Various flags and commands to know:
*** <code>git merge --squash</code>
*** <code>git merge --abort</code>
*** <code>git merge --continue</code>
*** <code>git branch -d</code>
** Merge Conflicts
*** Conflict markers <code><<<<<<<<<</code>, <code>=============</code>, <code>>>>>>>>>>>>></code>
** [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
