Difference between revisions of "DPS909 & OSD600 Fall 2019"

From CDOT Wiki
Jump to: navigation, search
(Week 1)
(Week 3)
(11 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
** [[OSD600]]
 
** [[OSD600]]
 
** How to be successful in this course
 
** How to be successful in this course
 +
 +
* Labs
 +
** Weekly labs, typically done in class
 +
** Labs are due on the Friday of the week they are assigned by midnight
 +
** Marked using Pass/Fail scheme
 +
** All labs must be completed to pass the course
 +
** [[DPS909 & OSD600 Fall 2019 - Lab 1|Lab 1]] is available now
  
 
* Releases
 
* Releases
** [https://wiki.cdot.senecacollege.ca/wiki/DPS909#Grading 4 releases, some with multiple bugs/PRs required]
+
** [https://wiki.cdot.senecacollege.ca/wiki/DPS909#Grading 4 releases, some with multiple bugs/PRs required], including participating in [https://hacktoberfest.digitalocean.com/ Hacktoberfest 2019]
 +
** Due Dates: Sept 20, Oct 31, Nov 20, Dec 6
 
** Chance to work on real code, real projects
 
** Chance to work on real code, real projects
 
** Big learning curve, lots of time required
 
** Big learning curve, lots of time required
 
** Amazing chance to gain experience, network, build your skills and resume
 
** Amazing chance to gain experience, network, build your skills and resume
 +
** Work with new and emerging technologies, gain exposure to tech outside the classroom
  
 
* Discussion/Readings
 
* Discussion/Readings
 
** Copyright ([https://www.youtube.com/watch?v=ljNS5p3cqls&feature=youtu.be Copyright in Canada video])
 
** Copyright ([https://www.youtube.com/watch?v=ljNS5p3cqls&feature=youtu.be Copyright in Canada video])
*** https://twitter.com/stan_sdcollins/status/1079395470731030528
 
 
*** [https://en.wikipedia.org/wiki/IANAL IANAL]
 
*** [https://en.wikipedia.org/wiki/IANAL IANAL]
 
*** Who created it, "owns" it.
 
*** Who created it, "owns" it.
Line 30: Line 38:
 
** [https://jvns.ca/blog/2018/09/01/learning-skills-you-can-practice/ Julia Evans, "How to teach yourself hard things"]
 
** [https://jvns.ca/blog/2018/09/01/learning-skills-you-can-practice/ Julia Evans, "How to teach yourself hard things"]
  
* Slack
+
== Week 2 ==
** https://seneca-open-source.slack.com
+
 
** [https://get.slack.help/hc/en-us/articles/115004071768-What-is-Slack Slack, Getting Started]
+
* Blogging
** [https://get.slack.help/hc/en-us/articles/217626358-Tour-the-Slack-app Tour the Slack app]
+
** Add bio/profile info as you feel comfortable, including links to GitHub, social media, etc.
 +
** Blog Post Tips:
 +
*** Use blog post titles that help a reader (or Google searcher) to know whether this is useful info to them
 +
*** Include links: a blog should connect different resources and ideas through your experience and learning
 +
*** Write in sections.  Try to avoid a wall of text, with only a single paragraph.  Consider using sub-headings, shorter paragraphs
 +
*** Use formatting for source code.
 +
** One good source of blog posts on open source and software development is [https://news.ycombinator.com Hacker News].  Some recent examples to look at for style:
 +
*** https://css-tricks.com/how-to-contribute-to-an-open-source-project/
 +
*** https://antoinevastel.com/javascript/2019/09/09/improving-obfuscator.html
 +
*** https://localghost.dev/2019/09/everything-i-googled-in-a-week-as-a-professional-software-engineer/
 +
*** https://randomascii.wordpress.com/2019/09/08/taskbar-latency-and-kernel-calls/
 +
 
 +
* 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?
 +
** [https://choosealicense.com/no-license/ what can I, can't I do?]
 +
 
 +
* Proprietary Licenses
 +
** [https://www.spotify.com/ca-en/legal/end-user-agreement/ Spotify End User Agreement]
 +
** [https://www.microsoft.com/en-us/Useterms/Retail/Windows/10/UseTerms_Retail_Windows_10_English.htm Microsoft Windows]
 +
** [https://www.apple.com/legal/sla/docs/iOS12.pdf iOS 12 (pdf)]
 +
 
 +
* Public Domain
 +
** [http://www.sqlite.org/copyright.html SQLite], which is now used by literally everybody, see http://www.sqlite.org/famous.html
 +
** [http://unlicense.org/ Unlicense]
 +
 
 +
* BSD License
 +
** Family of Licenses, including [https://opensource.org/licenses/bsd-license.php 2-Clause BSD], [https://opensource.org/licenses/BSD-3-Clause 3-Clause BSD (aka New BDS)], [https://en.wikipedia.org/wiki/BSD_licenses#4-clause_license_.28original_.22BSD_License.22.29 4-Clause BSD]
 +
** [https://www.freebsd.org/doc/en/articles/bsdl-gpl/article.html "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 [https://developers.google.com/v8/ V8], [https://www.chromium.org/Home Chromium], [https://golang.org/ Go]
 +
*** [https://d3js.org/ D3.js]
 +
*** [https://www.djangoproject.com/ Django]
 +
*** [https://www.nginx.com/ nginx]
 +
*** [http://ex-vi.sourceforge.net/ Vi]
 +
** 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
 +
 
 +
* Discussion of projects found for [[DPS909 & OSD600 Fall 2019 - Lab 1|Lab 1]]
 +
* [[DPS909 & OSD600 Fall 2019 - Lab 2|Lab 2]]
 +
* [[OSD & DPS909 Fall 2019 - Release 0.1|Release 0.1]] due Mon, Sept 23
 +
 
 +
== Week 3 ==
 +
 
 +
* '''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]
 +
 
 +
* '''Introducing [http://git-scm.com/ git] and [https://github.com/ GitHub]'''
 +
** Content Addressable Filesystem and Snapshots
 +
** Distributed: Local vs. Remote development
 +
** .git directory
 +
** Content Integrity, SHAs (Secure Hash Algorithm)
 +
*** <code>git init</code>
 +
*** <code>echo 'test content' | git hash-object -w --stdin</code>
 +
*** <code>ls .git/objects</code>
 +
*** <code>git cat-file -p d670460b4b4aece5915caf5c68d12f560a9fe3e4</code>
 +
** Blobs, Trees, and Commits
 +
** Branches, <code>master</code>
 +
** Working Directory, Staging Area, Repository
 +
** What do these commands really do?
 +
*** <code>git clone url-to-git-repo</code>
 +
*** <code>git add file.txt</code>
 +
*** <code>git status</code>
 +
*** <code>git rm file.txt</code>
 +
*** <code>git commit -m "Added file.txt"</code>
 +
** Remotes, <code>origin</code>, <code>upstream</code>
 +
 
 +
* 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]
  
* First open technologies and projects we'll be using:
+
* [[OSD & DPS909 Fall 2019 - Release 0.1|Release 0.1]] due Mon, Sept 23
** [https://github.com/nodejs/node node.js]
 
** [https://nodejs.org/api/fs.html node fs module docs]
 
** [https://github.com/filerjs/filer filer]
 
** [https://mochajs.org/ mocha]
 

Revision as of 11:09, 16 September 2019

Week 1

  • Course introduction
  • Labs
    • Weekly labs, typically done in class
    • Labs are due on the Friday of the week they are assigned by midnight
    • Marked using Pass/Fail scheme
    • All labs must be completed to pass the course
    • Lab 1 is available now
  • Releases
    • 4 releases, some with multiple bugs/PRs required, including participating in Hacktoberfest 2019
    • Due Dates: Sept 20, Oct 31, Nov 20, Dec 6
    • 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
    • Work with new and emerging technologies, gain exposure to tech outside the classroom
  • 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)

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

  • Introducing git and GitHub
    • Content Addressable Filesystem and Snapshots
    • Distributed: Local vs. Remote development
    • .git directory
    • Content Integrity, SHAs (Secure Hash Algorithm)
      • git init
      • echo 'test content' | git hash-object -w --stdin
      • ls .git/objects
      • git cat-file -p d670460b4b4aece5915caf5c68d12f560a9fe3e4
    • Blobs, Trees, and Commits
    • Branches, master
    • Working Directory, Staging Area, Repository
    • What do these commands really do?
      • git clone url-to-git-repo
      • git add file.txt
      • git status
      • git rm file.txt
      • git commit -m "Added file.txt"
    • Remotes, origin, upstream