View source for OSD & DPS909 Winter 2019 Release 0.1

=Release 0.1=

==Due Date==

Wednesday January 30th.  See Requirements below for details on what needs to be included in your submission.

==Overview==

This first release is designed to expose you to the common workflows and tools involved in contributing to open source projects on GitHub.  In order to give every student a similar learning experience, we will all be working on the same project and code.  NOTE: in subsequent releases, students will have more freedom to contribute to other projects.

Our goal will be to modernize code in the [https://github.com/filerjs/filer Filer] web filesystem project.  Filer implements the [https://nodejs.org/api/fs.html node.js fs module], providing a way to read, write, and manipulate files and directories in web pages using [https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API IndexedDB] as a backing data store.

The code was written before some modern syntax in JavaScript was common, and it needs to be updated.

==Learning Goals==

In addition to the actual code you will write, the ultimate goal of this first release is to help you gain experience in many aspects of open source development and contribution, specifically:

* reading and searching through existing code
* working with branches, commits and other aspects of git
* creating Pull Requests in GitHub
* filing, triaging, and working with Issues on GitHub
* running automated unit tests, specifically using mocha and karma
* working with static analysis tools, specifically eslint
* continuous integration and automation, specifically using Travis CI
* working in an open source community
* reviewing other contributor's Pull Requests
* using open communication tools, such as Slack
* writing about your own work via your Blog

==Technologies==

Web pages are sandboxed from the operating system, and normally there is no way to work with files and directories.  However, many existing applications rely on access to a full filesystem, for example, editors.  Anyone wanting to create a web application that needs to work with files and directories can use Filer, and the data will persist between sessions.

Filer shares no code with node.js, since node is meant to be run directly in an operating system vs. a browser.  Instead, Filer implements the same interface (i.e., set of functions and objects) as the fs module, making it possible for developers to port an application from working only on node, to working in the browser as well.

Filer uses [https://mochajs.org/ mochajs] and the [http://www.chaijs.com/guide/styles/#expect chai expect assertion library] for its tests.  Most of the tests are located in [https://github.com/filerjs/filer/tree/develop/tests/spec tests/spec].  The complete list of tests that gets run is located in [https://github.com/filerjs/filer/blob/develop/tests/index.js tests/index.js].  NOTE: if you add a new test file, it needs to get added to this file as well.

Details on how to setup and run the tests are available in [https://github.com/filerjs/filer/blob/develop/CONTRIBUTING.md#how-to-contribute CONTRIBUTING.md].

==Filing an Issue==

Modern JavaScript prefers <code>let</code> and <code>const</code> to <code>var</code> for creating variables and constants:

* [https://medium.com/@pandeysoni/when-should-use-const-and-let-instead-of-var-in-javascript-ec2c3d7e5ca6 When should you use const and let instead of var in JavaScript?]
* [https://medium.freecodecamp.org/javascripts-var-let-and-const-variables-explained-with-a-story-2038e3c6b2f9 JavaScript's var, let, and const variables explained with a story]
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/const MDN docs on const]
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/var MDN docs on var]
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/let MDN docs on let]
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Strict_mode MDN docs on strict mode]

Filer currently uses <code>var</code> almost everywhere.  We should update the code to use <code>let</code> and <code>const</code> and strict mode.

You are asked to pick a file in the <code>tests/</code> directory and update the code to use modern variable creation, as well as strict mode.

Before you begin, file a new Issue in GitHub.  When you file your Issue, you should first make sure that no one else has already filed the same thing.  This is known as a "dupe" (i.e., a duplicate bug).  Make sure you include enough information to make it clear what the problem is.  For example, "Update code in tests/some/file.js to use const/let."

==Fixing Your Issue==

Once your issue is filed, begin your fix by forking Filer and creating a new branch.  You must create a new branch before you commit any code or submit a pull request.  If your Issue was #123, create a branch named issue-123.

Make sure you can [https://github.com/filerjs/filer/blob/develop/CONTRIBUTING.md#how-to-contribute run the existing tests], and that they all pass.  You want to make sure everything is working before you begin

On your new branch, you can make as many commits as you need to.  Don't worry if you make mistakes, or need to overwrite/undo something; just add more commits to fix the problems.  If you need to add new test files, that's fine, or you might be able to add to an existing file.  Also, do not merge any code into your branch.  Leave that for the very end, when your fully reviewed and corrected pull request will (hopefully) get merged by a Filer maintainer.

==Getting Help==

At every stage of your work, make sure you ask for help, and get feedback from others in the community by asking questions.  Don't struggle on your own and get stuck, or miss the due date.

Please use the [https://github.com/filerjs/filer/issues Filer GitHub Issues] and [https://seneca-open-source.slack.com Open Source Slack].

==Requirements==

You will be graded on the following.  Please make sure you have addressed everything that makes sense below:

* Proper Pull Request to Filer
** An Issue should be filed before your create your Pull Request.  The Issue must have a complete subject and description of the problem or change you believe needs to be made.
** The Pull Request should reference the Issue Number in its description (e.g., "Fixes #123: Add test for ...")
** Changes must be made on a new branch (e.g., if you are fixing Issue 123, use issue-123 as your branch name)
** Proper code to fix your Issue
** Code or Tests must pass eslint
** All Unit Tests must pass after your changes are made (i.e., new tests must pass, and you must not break existing tests)
** Co-ordination with other student/community Pull Requests.  Make sure you don't duplicate another fix or change that someone else has already done.
* Review of Another Student's Pull Request
** Compare the Pull Request to the related Issue it is trying to fix.  Has everything been covered?
** Confirm that there are no other related Issues or Pull Requests that might conflict with this Pull Request
** Confirm that tests, code, and other automated tests run correctly and all pass
** Review code and other changes, making comments and suggestions about any improvements you can see, or other issues that need to be addressed
* Blog Post
** Discussion of the change(s) you made.  What was your process?  What did you learn?  What would you do differently next time, or what worked and you would do again?
** Link to the Issue(s) you filed, and discuss the bug/problem/addition you wanted to address.
** Link to the Pull Request(s) you created, and discuss the fix.
** Link to the Pull Request(s) you reviewed, and discuss what you did and found.
** Discussion of what you did to address your review comments.
** Evidence of Community Involvement.  Could be Issues you worked in to help others, help you gave people on Slack, mentoring or other help you gave people in person.  How did you engage with the community of developers working on Filer?
* Add Info to Table Below
** Make sure you Name, Blog URL, Pull Request URLs, etc are all included

==Submission==

When you have completed all the requirements above, please add your details to the table below.

{| class="wikitable"
! Name
! Blog Post (URL)
! Issue (URL)
! Pull Request (URL)
|-
| Andrew Koung
| https://andrewkoung.wordpress.com/2019/01/25/release-0-1-blog/
| https://github.com/filerjs/filer/issues/661
| https://github.com/filerjs/filer/pull/669
|-
| Nathaniel Ngo
| https://medium.com/@ngonathaniel/refactoring-code-to-conform-to-es6-standards-79084b723bb2
| https://github.com/filerjs/filer/issues/674
| https://github.com/filerjs/filer/pull/676
|-
| Jatin Kumar
| https://jatinkumar.home.blog/2019/01/27/my-first-open-source-contribution-experience/
| https://github.com/filerjs/filer/issues/667
| https://github.com/filerjs/filer/pull/675
|-
| Vladimir Rozin
| https://codingmoments1618.blogspot.com/2019/01/filerjs-experience.html
| https://github.com/filerjs/filer/issues/666
| https://github.com/filerjs/filer/pull/680
|-
| Jacob Adach
| https://jadach1201231188.wordpress.com/2019/01/27/release-0-1/
| https://github.com/filerjs/filer/issues/677
| https://github.com/filerjs/filer/pull/678
|-
| Brandon Wissmann
| https://medium.com/@brandonjwissmann/contributing-to-filerjs-fc4b91fed63c
| https://github.com/filerjs/filer/issues/662
| https://github.com/filerjs/filer/pull/668
|-
|Iryna Thompson
| https://iraokth.wordpress.com/2019/01/28/filer-project-release-01/
| https://github.com/filerjs/filer/issues/665
| https://github.com/filerjs/filer/pull/688
|-
| Woosle Park
| https://woosleparkdpd909.wordpress.com/2019/01/29/release-0-1/
| https://github.com/filerjs/filer/issues/681
| https://github.com/filerjs/filer/pull/695
|-
| Yuansheng Lu
| https://luysh0420.wordpress.com/2019/01/29/release-0-1-filer-project/
| https://github.com/filerjs/filer/issues/660
| https://github.com/filerjs/filer/pull/694
|-
| Vincent Logozzo
| https://vlogozzo.blogspot.com/2019/01/modernizing-filerjs.html
| https://github.com/filerjs/filer/issues/689
| https://github.com/filerjs/filer/pull/700
|-
|Olena Vyshnevska
|https://olenavyshnevska.blogspot.com/2019/01/filer-project-release-01.html
|https://github.com/filerjs/filer/issues/658
|https://github.com/filerjs/filer/pull/704
|-
|Priyam Brahmbhatt
|https://release01.blogspot.com/2019/01/release-01.html
|https://github.com/filerjs/filer/issues/698
|https://github.com/filerjs/filer/pull/709/files
|-
|Alexei Bonilla
|https://abonilla1.blogspot.com/2019/01/bons-blog-2.html
|https://github.com/filerjs/filer/issues/699
|https://github.com/filerjs/filer/pull/706
|-
|Xiaowei Huang
|https://violethxw.wordpress.com/2019/01/30/release-0-1-filer-github-issues/
|https://github.com/filerjs/filer/issues/692
|https://github.com/filerjs/filer/pull/696
|-
|David Li
|https://dli119seneca.wordpress.com/release-0-1/
|https://github.com/filerjs/filer/issues/708
|https://github.com/filerjs/filer/pull/713
|-
|Harsh Patel
|https://harsh604310081.wordpress.com/2019/01/30/release-1-0-getting-started/
|https://github.com/filerjs/filer/issues/707
|https://github.com/filerjs/filer/pull/712
|-
|Rachael Scotchmer
|https://rscotchmer.blogspot.com/2019/01/release-01-my-first-open-source.html
|https://github.com/filerjs/filer/issues/684
|https://github.com/filerjs/filer/pull/697
|-
|Paul Moon
|https://paulmoonblog.wordpress.com/2019/01/30/contribution-to-node-js-filer/
|https://github.com/filerjs/filer/issues/683
|https://github.com/filerjs/filer/pull/693
|-
|Ahmed Deeb
|https://amddeeb.wordpress.com/2019/01/30/changing-var-to-let-and-const-and-adding-strict-mode/
|https://github.com/filerjs/filer/issues/716
|https://github.com/filerjs/filer/pull/720
|-
|QingLian Liu
|https://aliceliudps909.blogspot.com/2019/01/dps-909-first-open-source-contribution.html
|https://github.com/filerjs/filer/issues/682
|https://github.com/filerjs/filer/pull/723
|-
|Sahib Arora
|https://medium.com/@sahibarora1997/beginning-with-github-6fc29b115449
|https://github.com/filerjs/filer/issues/702
|https://github.com/filerjs/filer/pull/726
|-
|Arash Negari
|https://adventuresoftechman.wordpress.com/2019/01/30/release-0-1-filer-project/
|https://github.com/filerjs/filer/issues/664
|https://github.com/filerjs/filer/pull/718
|-
|Colin Chumak
|https://cmchumak.home.blog/2019/01/31/release-1-0/
|https://github.com/filerjs/filer/issues/686
|https://github.com/filerjs/filer/pull/717
|-
|Abdirahman Guled
|https://medium.com/@abdishire15/my-first-open-source-contribution-da0f11e60133
|https://github.com/filerjs/filer/issues/710
|https://github.com/filerjs/filer/pull/729
|-
|Kevin Chan
|https://kevinchan97.blogspot.com/2019/01/release-0.1-filer.html
|https://github.com/filerjs/filer/issues/728
|https://github.com/filerjs/filer/pull/730
|-
|Oleksii Polovyi
|https://apolllondev.wordpress.com/2019/01/31/release-0-1-pr-for-filerjs/
|https://github.com/filerjs/filer/issues/672
|https://github.com/filerjs/filer/pull/722
|-
|Adel El Masery
|https://medium.com/@a_elmasery/modernizing-code-for-filerjs-1b0cbdfb6b83
|https://github.com/filerjs/filer/issues/719
|https://github.com/filerjs/filer/pull/731
|-
|Al Vincent Valdez
|https://alvinvaldez656226608.wordpress.com/2019/01/31/release-0-1-node-js-filer/
|https://github.com/filerjs/filer/issues/670
|https://github.com/filerjs/filer/pull/687
|-
|Jiajie Feng
|https://yingtao101112.wordpress.com/2019/01/31/release-1-modernizing-code-for-filerjs/
|https://github.com/filerjs/filer/issues/724 
|https://github.com/filerjs/filer/pull/725
|-
|Oleksandr Tkach
|https://tkacholeksandr.home.blog/2019/01/30/first-release/
|https://github.com/filerjs/filer/issues/714
|https://github.com/filerjs/filer/pull/732
|-
|Anh Hoai Ung
|https://anhcoding.wordpress.com/2019/01/31/release-0-1/
|https://github.com/filerjs/filer/issues/715
|https://github.com/filerjs/filer/pull/727
|-
|Dillon Coull
|https://terriblyuncreativeopensourceblogtitles.wordpress.com/2019/01/31/release-0-1-issues-and-pull-requests/
|https://github.com/filerjs/filer/issues/703
|https://github.com/filerjs/filer/pull/711
|-
|Priyanka Dhiman
|https://medium.com/@priyankacodes/a-little-taste-of-open-source-5772e3dbb328
|https://github.com/filerjs/filer/issues/685
|https://github.com/filerjs/filer/pull/733
|-
|Aqeel Parpia
|https://medium.com/@aqeelparpia/github-guide-for-beginners-4ae66dc736b9
|https://github.com/filerjs/filer/issues/734
|https://github.com/filerjs/filer/pull/735
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-