667
edits
Changes
→Week 6
* [[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
