Git Rebase

This week in OSD-600, more git features were introduced to me, the main focus of the week and the lab is on the rebase feature of Git, this is an extremely powerful tool and what it is capable of doing is amazing. Once again, I was asked to modify the DLCheck tool project codes to further improve it, not only improvements in the codes, but also improvements in the git commit history.

To begin the improvement attempt, I took a close look into my project, and it didn't take long for me to find a couple issues. The first issue was obvious and I have thought about making this change for a while, that is to move some of the functions into an independent file instead of leaving them in index.js. Therefore, I created another file called displayMessage.js, moved the display message functions into that file and exported them using module.exports, now the index.js file looks cleaner and it still has access to those functions. The second change I made to the project is simply changing a variable name iList to ignoreList, this was used by my partner from the previous lab and I found it to be a little confusing, I read the code block for a bit and realized that it was a list of ignored objects, therefore the name was changed since it's more descriptive. The last change was changing one of the check conditions, the check condition used "==" instead of "===", this was also implemented by my previous lab partner, in my check conditions for command line arguments, I've used "===" for all, to keep the consistency, I changed his code to match my style.

After all the updates were committed, now it's the rebase part, the interactive rebase was easy to use, by using squash method, It was able to combine three different commits into one without any problem, this was amazing. After the commits were combined, I used "git commit -amend" to update the commit message and merged the updates into the master branch, then finally pushed the updates onto the origin on GitHub.


GitHub Commit: https://github.com/Wei-J-Huang/dlcheck/commit/8209ed617da49df6e059b7486de5ecbb10aac6f3

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