First Contribution of Hacktoberfest

For the first week of Hacktoberfest, I contributed to Matrix-Appservice-Discord, a service that connects Discord to Matrix, an application that allows you to message people over multiple different messengers in one place.

The Issue

As I wanted to focus more on familiarizing myself with the process of contributing on Git, I chose a simple issue; fixing a spelling error. The issue involved correcting the misspelling 'insufficiant' to 'insufficient'.

The Fix

After forking the repo, I cloned the develop branch of the project and began my work. While Matrix-Appservice-Discord was written in TypeScript, I didn't need to use it for the purposes of this fix. I simply searched for instances of 'insufficiant' and changed them to 'insufficient'.


The two instances of 'insufficiant'


Creating the Pull Request

Once I finished the fix, I created a new branch on the forked repo, spelling-error-insufficiant, and pushed my changes to there. I then created a pull request to merge my branch with the develop branch on the original repo, stating which error I fixed in the commit message. I noticed that my pull request failed the automatic code tests, but it turned out that it wasn't and issue with the code. Afterwards, my pull request was accepted by a maintainer and merged into the original repo.

Issues and Lessons Learned

On my initial clone, I cloned the master branch of the repo, and tried to merge into develop. I noticed that there were conflicts because of differences in the master and develop branch. Eventually I figured out you can specify a branch when cloning. Once I solved the conflicts, I noticed that my code failed the automatic checks run by Github, despite only having changed 2 lines of code. After asking the maintainers I was informed that the issues were on the original code, and weren't caused by my changes. Finally, while creating the pull request, I learned that you can reference specific issues in the commit message,and Github will automatically connect the pull request with the issue.








Comments

Post a Comment

Popular posts from this blog

External Pull Request and Creating a Spam Checker for Telescope

Image
This week I was working on two projects: fixing an error with Pokemon Showdown's downloaded match replays, and creating a spam checker for Telescope Pokemon Showdown Client The Issue   Resume button appears under Play button on launch The external issue I worked on was preventing the Resume button from appearing behind the Play button when viewing a downloaded replay from Pokemon Showdown: something I thought would be more complex than it ended up being, having worked with Pokemon Showdown before. The Fix After finding the class I had to work on, replay-embed.js,  I had to figure out how downloaded replays worked with replay-embed. While waiting for a response from Zarel, I tried generating a replay using my cloned version for Pokemon Showdown Client to no avail. Eventually, I learned from Zarel that the replay file has to be edited so that the script source points to my version of replay-embed. I changed the path to the filepath to my copy of replay-embed, but th...
Read more

Setting Up for Second External Pull Request and Contribution to Telescope

Image
Our assignment for this week is the same as the assignment we had last week; to make a large contribution to one external project and to make a contribution to Telescope; our internal project. While I am still trying to decide on what issues I will tackle, I worked on a small fix for my contribution to Telescope from last week: spam-checker.js . The Issue In my last contribution, I created a spam checker that determined whether or no a post was spam using a combination of rules and a spam filter function. In my function, the blog post's body content was parsed before any of the checks were run, but if the blog's title was empty or marked as spam the body contents didn't need to be checked. A classmate suggested that I move the blog body parsing to after the title checks to save on resources if title checks failed and the body didn't need to be loaded. The original order of checks, body is parsed before any checks are run The Fix After moving the content par...
Read more

Second Contribution of Hacktoberfest

Image
For the second week of Hacktoberfest, I contributed to Fast Read , a React App created by Hamzaolak. The Fast Read Application The Issue   As I was having issues with the other projects I was planning to work on, I settled on another simple fix; changing the names of the custom colors defined in the code. The Fix After finding the color definitions, all I had to do was change the names in the definitions, as well as in the files that use those colors. The color names being in the issue description was helpful, especially with them being in the same order as the original colors. Creating the Pull Request After confirming that everything works as intended, I switched the origin remote to my forked version of the repo. Then I created a new branch and pushed my commit to it. Finally, I created a pull request to merge my code into the original project. Issues and Lessons Learned While searching for projects to contribute to for this week, I noticed ...
Read more