First Github Pull Request

Since I partnered up with 2 people for lab 1, I have decided to do this with the same people again for this lab. I spent a good amount of time to read and tried to understand the logic and purpose of code before I began updating the project.

As I read the lab instructions, I realized that the goal is to add an extra feature to other's project, this is amazing because we get to make real contributions to other's work. It was easy for me to decide what to add onto my partner's codes because I knew a crucial part that his release 0.1 lacks, which is the timeout settings and error catching when making requests to the URLs. In his project, the Axios module was used to make those requests, I did a little bit of research and found out that the default timeout for an Axios request is 0, therefore, some links may keep the program waiting for a long period of time, which may cause the program to freeze, therefore I added in the timeout setting in the request to make the tool display ETIMEOUT errors for those links, while I was at it, I also changed the catch block to display any other errors after receiving the response from servers.

My other partner reviewed my code and added a very useful feature to my project, that is allowing the user to pass in multiple files in one command to have the tool to check all of those files and he was nice enough to update the README file as well.

Throughout the process of this lab, the three of us have used slack to communicate with each other when running into problems, such as asking the purpose of certain code block and asking how to run other's program locally instead of installing their npm package, this is required to test the updates. Before making the PR, I have shown the add-on code to my partner to make sure that we both agree on the changes in case if I made any mistakes. I have learned a couple of new things from this lab, such as making a PR, understood some git commands and enhanced my collaboration skills.

URLS:


Comments

Post a Comment

Popular posts from this blog

Working on the Telescope Project

Image
Two weeks ago, I've had my first chance of working with the Telescope project and utilized it's back-end API to work with my DLCheck Project. In the past few days, I got more involved, played around and worked with Telescope's front-end portion. One of the issues that I found in the project repository got an idea from the Node.js webpage and requested for a React Component to display the contributors' information to thank them for their effort in developing/maintaining the Telescope project. In the beginning, I was a bit lost by reading the existing code, but luckily, the telescope project was developed using the React JS library and utilizes Material-UI framework, I have worked with a project which was also developed using the same tools during my Release 0.2 assignment, therefore, I was able to understand pieces of codes fairly quick. The new Card Component was overall not that hard to implement but it still took me a quite bit of time, I was given a custom React Hook...
Read more

Hacktoberfest -1

 This week the Hacktoberfest event has finally started and I had the chance to contribute to real open source projects. Finding an issue that I can fix took way longer than I thought it would, most of the issues were either taken or they were too complicated for a first time contributor. After a while of searching around GitHub repos with "good-first-issue" labels applied, I found a couple repositories that seemed interesting to me. One of the repositories requested for a new URL redirects in their projects, I thought this was an easy fix, but that it was more complicated than I thought it would be, the original repository had no instruction on how to run and test the application, therefore, I had to leave a comment in the issue asking for instructions. As it turns out a test must be written first before adding any code to the project, and when I ran the initial test before adding anything into the project, I was already getting testing errors, it seems like a challenging one...
Read more

Using Code Formatter and Linter

This week I was introduced to automated code formatting and linter to check for mistakes in code, I have heard of those tools before but never used them until this week. Those tools assisted me to maintain the code structure and readability, using those tools resulted in huge differences between the original project and "fixed project". To install Prettier, I followed their official installation instructions, which can be found here , and I did the same to install ESLint . There was a small problem that I ran into when I ran "eslint file.js" command, the system warmed that "eslint" is not a valid command, this was eventually solved by installing the eslint-cli, which was not mentioned in the official instructions. After I finished the set ups and configurated the tools, I ran the "script npx prettier --write ." to automate the formatting, this changed hundreds of lines in my .js files, I wasn't really surprised by this because I have always t...
Read more