Release 0.3 PR1

 For release 3 we have to make 2 PR's. The first one must be for the Telesope project and the second one must be for an external project. These PR's must "build up" from the PR's we did for release 0.2. This blog post will highlight working on the PR for an external project. David suggests to "consider working on a repository/project you've already worked on in the past and have set up on your local machine". I took that advice when I started searching. Back in October, I worked on this repository, a collection of different kinds of algorithms written in different programming languages. In October I made a PR to add the Cocktail sort algorithm in C++. At the time this was good since I did not do much work with algorithms before. However, there was a new issue for the project that was perfect for release 0.3. This issue wanted people to add unit tests for an algorithm currently present in the repository. I have never written a unit test before and did not know much about what they are or how to write one so I really excited to work on this issue. After I forked and cloned the code I started my research. I first looked into the current unit test folders to get an idea of what needed to be done. I searched in the JavaScript/UnitTest folder. The last time I worked on this repository I did something in C++, so I wanted to do a different language.  I was aware of jest: a pretty popular library for writing tests in JavaScript but I didn't know much about it. I also realized the current unit test in the  JavaScript folder was written in jest. So I decided to do some research on how to write a unit test using Jest. The two main reasons I did this were: There already was a unit test written with jest and I wanted to follow their coding style, and I know Jest is used in Telescope so this was a good time to prepare myself for a possible Telescope issue.  I first read this article to get familiar with jest and how to use it. After that, I started writing a test for the insertion_sort algorithm in JavaScript. For the most part, writing the test went well, however, there were some minor roadblocks I encountered. When testing it kept failing for 2 reasons: 

1. Although I imported the file with the algorithm it kept saying it could not find the function. Turns out I put the wrong path when importing the file.

2. At first I did describe() instead of test(). This made the code crash since describe() has different parameters then test().

After I fixed those errors I was able to get it working!

In the end, I am really happy with this PR since I learned a new skill. The semester is still not over and we still have a couple more weeks. I am really excited about this as I am sure my knowledge of Open Source will continue to expand!   






Comments

Post a Comment

Popular posts from this blog

OSD600 Release 0.4 Part 3

Image
 This is the last blog for OSD600 and the last part of release 0.4! I am excited to be writing this as after this I will be done with everything I need to do for my classes this semester, and graduate! One issue I noticed while working on this is I did not fully understand what was needed to "port" a component from Gatsby to Next. At first, I thought everything you needed to do to port a component was in this migration guide  posted in the issue . After talking to some people on Slack I learned we must not only follow the migration guide but also convert the JavaScript code in the components to TypeScript. I have worked with Typescript before so I had an idea of how it works/what it is (it's basically JavaScript with types), but I never knew how to convert JavaScript code to TypeScript code. After doing some research I learned this process can be broken down into two simple steps: 1. Change all the .jsx files to .tsx files. 2. Add types to all the variables made. Eg. func
Read more

OSD600 Lab 5

Image
 This week we learned about rebasing in Git! Rebasing is basically taking multiple commits and "grouping" or "moving" them into one commit. Before I started the lab I did the walkthrough on the OSD600 GitHub Wiki. At first, I struggled with it (kept getting errors when running git rebase master -i). Then I decided to start over again and I noticed the first time I forgot to commit some files on the refactor branch. I am happy I did this first because it made the lab go very smoothly.  Before I started the lab I took a look at my code and wrote down the improvements I was planning to make. I decided to do these 3 things: change my regular expression variable from a let to a const, remove an array I never used, and update some functions to use the ES6 arrow syntax. It's been a while since I used arrow functions so I used this resource to guide me Every time I added and tested a feature I did a git commit. One improvement that caused an error was when I updated som
Read more

Release 0.3 PR2

Image
  For release 3 we have to make 2 PR's. The first one must be for the  Telesope project  and the second one must be for an external project. These PR's must "build up" from the PR's we did for release 0.2. This blog post will highlight working on the PR for Telescope. When I started this the first place I went was to the issues page on the Telescope repository. I saw there were some tests that needed to be written and were interested in taking on one of these issues. These were more complex than the test I wrote for the first part of 0.3 so  I saw it as a good opportunity to improve my skill. I asked in Slack for some advice on what to do and was given this idea from David: This seemed like a good test to write (challenging but something I can figure out) so I made an issue for it and started working! When I first wrote the test everything looked fine but it kept on failing. At first, I thought that's good, if we pass an invalid date shouldn't the test fa
Read more