Hacktoberfest: Second Pull Request - wanikani-notifier

-

 This post describes the journey of the second pull request for Hacktoberfest which encourages new people to get involved in the open-source community. The post for the first pull request for Hacktoberfest is the following: https://hyunjijanelee.blogspot.com/2020/10/hacktoberfest-first-pull-request-tower.html

In this time, I have struggled to find an issue to work on. Most of the issues I would like to work on are already taken to another person and other issues have some problems on the project so I cannot run it properly. I kept finding a proper project and found one project named wanikani-notifier. The link for the wanikani-notifier is the following: https://github.com/upsetdog/wanikani-notifier

When I found an issue with this project, I cloned the project to check whether I can run this project. At that time, I found it has another issue to make it better. On this project, there is no 'package-lock.json' file so users need to install modules checking what modules are needed for this project. It would be much better if this project has package-lock.json file so users can simply install modules when they enter 'npm install'. Therefore, I filed an issue to ask whether I can do this task. The link for the issue is the following: https://github.com/upsetdog/wanikani-notifier/issues/9. The owner of this project assigned me to this task so I started working on it.

I've installed modules to create package-lock.json file. Also, I've updated README.md file so users can follow the step to build this project. The first code below is the step before and the second one is the step I've updated.

- The previous installation process

Clone the repository, install the required packages, and run node index.js it'll run until you cancel it. replace "YOUR TOKEN HERE" with your wanikani api v2 token, in the config.json file

- The updated installation process

1. Clone the repository
2. Install the required packages entering 'npm install'
3. Replace "YOUR TOKEN HERE" in the config.json file with your wanikani  api v2 token
4. Run node index.js it'll run until you cancel it

I've added my changes and created a pull request for this issue. Currently, I am waiting for reviewing. The link to my pull request is the following: https://github.com/upsetdog/wanikani-notifier/pull/10

Finding an issue to work on takes most of the time for this pull request. I've learned it would be better to find an issue as fast as possible. Also, I realized I had so much fun finding another issue has not been filed yet and fixing the issue. It was a really good practice.

Comments

Post a Comment

Popular posts from this blog

Lab 8: Automated Testing and Continuous Integration

-
When I developed a program, it was time-consuming to test all the functions I created when I add a feature. I needed to run each feature, check whether it gives expected output or not, and check all the output. It is possible I forgot to test a feature and later on, I realize I did not test the feature. I wonder if there any ways I can do it automatically. Now, I got the way how to do that. There is automated testing for it! To begin with it, I started searching the testing framework to apply my command-line tool named url-fi. There are some testing frameworks for Node.js such as Jest, Mocha, and AVA. The testing framework I chose is  Jest  which is a testing framework developed by Facebook. I've installed Jest running 'npm install --save-dev jest' and test whether it works properly or not.  This document  is the way I followed to install the Jest testing framework. After I've installed the Jest testing framework, I worked on separating functions. As my tool contains al
Read more

Open Source Project: Lab2 (Pull Request)

-
Image
 Introduction In this lab, I practiced contributing and submitting pull requests to other repositories I don't own. Following the lab instruction , the things I plan to practice are the following: forking and cloning other projects creating branches to work on new features and fix bugs working on code I didn't write, trying to maintain the original style and not break things creating pull requests collaborating with other developers on GitHub updating my pull requests to include fixes for review comments The Project I picked for pull request ( https://github.com/lixiaoqity/testLink/pull/7 ) I looked around the classmates' open source project and picked the project named testLink. The GitHub repository link is the following:  https://github.com/lixiaoqity/testLink/pull/7 .  I picked this project because it also uses the NodeJS which I picked for my project. It was really interesting to see how code can be written differently for the same subject. When I look over the project
Read more

Project: Final

-
Introduction In this post, I will describe the summary of how I have done each stage. The purpose of this post is for wrapping up this project. The purpose of the project is the optimization of one open-source project. I need to compile, benchmark, profiling, and optimize the software. The detailed information about the project is described in the  SPO600 winter project .  Previous posts related to this project The previous posts for this project are listed below. You can read the detailed steps of how I have done each stage. Stage 1 Project Stage 1 - Compiling and Benchmark Butteraugli Stage 2 Project Stage 2 - Profiling Butteraugli Project Stage 2: Profiling (x86_64) The links for the results Project: Organize the Results Stage 3 Project Stage 3: Optimization Stage 1 Stage 1 is for building and benchmarking the performance of an open-source software package. There are some requirements for the open-source package I need to consider. Firstly, the time for testin
Read more