Difference between revisions of "DPS909 & OSD600 Fall 2018"
(→Week 2) |
|||
Line 90: | Line 90: | ||
* [[DPS909/OSD600 Fall 2018 Lab 1|Lab 1]] | * [[DPS909/OSD600 Fall 2018 Lab 1|Lab 1]] | ||
+ | |||
+ | == Week 2 == | ||
+ | |||
+ | * '''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://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] | ||
+ | |||
+ | * Some real world examples: | ||
+ | ** Filing, Fixing a bug in Filer | ||
+ | ** Filing, Fixing a bug in node.js | ||
+ | |||
+ | * [[DPS909/OSD600 Fall 2018 Lab 2|Lab 2]] |
Revision as of 10:19, 16 September 2018
Week 1
- 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?
- Microsoft buys GitHub for 7.5 Billion - "We're all in on open source"
- Julia Evans, "How to teach yourself hard things"
- Copyright (Copyright in Canada video)
- First open technologies and projects we'll be using:
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:
- 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
Week 2
- Readings/Resources
- 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
- set up git and GitHub
- Some real world examples:
- Filing, Fixing a bug in Filer
- Filing, Fixing a bug in node.js