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 for the first PR considering the amount of time I have, therefore, I decided to go with another repository and save this one for later.

The repository I actually worked on this week is a public maintained code library for data structure and algorithms in different languages, they were looking for someone to produce a bubble sort algorithm code in typescript. This seemed like a good issue for my first pull request, so I have asked to contribute and was soon assigned to resolve the issue. After I cloned the repo, I have noticed that this algorithm was already implemented by someone else in regular JavaScript in the same project, since TypeScript is extended from JavaScript, I have decided to just add in type declarations for variables and reuse the JavaScript version code made by the other contributor to keep the consistency within the project. Since I have never worked with TypeScript on it's own, I had no idea how to compile my program in VS Code, I did some researching on Google and found out that it could simply be done by using the tsc module. After a bit of work, I pushed my code onto GitHub and sent a pull request, during the PR process, I noticed that they have automated testing in pull requests, I was expecting to run into issues since this was my first time contributing to real projects, and as expected it was declined, because I had a console.log call to display the sorted output of the array, it seemed like they don't want me to include that, so I went ahead and deleted that line of code on the same branch and the PR process started over again, and it was once again stopped by a member of the repo because I forgot to edit the README to indicate that this algorithm has been done. After a few rounds of updating, my work was eventually accepted and merged.

This attempt of PR was a huge mess, but the community was supportive, and it was a great learning opportunity, which helps me to prevent making the same mistakes for the future contributions.

Repo: https://github.com/FOSS-UCSC/FOSSALGO

Issue: https://github.com/FOSS-UCSC/FOSSALGO/issues/486

PR: https://github.com/FOSS-UCSC/FOSSALGO/pull/512

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

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