Reading Level in Telescope: Internal Contribution

Last week, I completed my internal pull request for this assignment: implementing reading-level.

The Issue

Lozinska suggested that we implement a feature to measure the writing level of blog posts, and  cyh0968 suggested we use the reading-level node.

The Fix

After installing reading-level,  I read up on the documentation to figure out how to use it and what it was returning. I learned that calling reading-level with the arguments 'full' and the text to be analyzed returns an object containing the reading level among other things. I created reading-level.js and exported the reading-level function.

Exporting reading-level
After finishing reading-level.js, I began creating tests for the feature. I found example data in the documentation and decided to use it for the tests, as I knew what the results should be. I decided to compare the unrounded reading level in the tests as I figured that was the most important value in the returned object. I also made sure to test cases that should return errors.

Some of the tests written for reading-level
Once I finished with the tests, I added some documentation to reading-level.js explaining the properties of the returned object and how to use the feature, then I created a pull request for my branch.

Community Interaction

As I didn't add much code implementing reading-level, the review process went smoothly, and my pull request got accepted without any issues.

Initially I was hesitant to pick up this issue, as I the last comment was someone asking if they could assign themselves to it. However, the last action shown was that person unassigning themselves and the issue had not been updated in around 2 weeks. Eventually, I figured that that person probably wasn't working on the issue anymore and assigned it to myself.

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 the bat
Read more

Adding 'Favorite' System to Pokemon Showdown: External Pull Request and Final Week of OSD600

Image
Despite saying I wanted to work on a new repo for my final external pull request, after not being able to find a suitable issue, I ended up contributing to the Pokemon Showdown Client again. This time, I added an even larger feature than my last one: a 'favoriting' system that lets users quickly access users they play with frequently. The Issue Currently, the only way to match up with specific users on Pokemon Showdown is to either search them by username, or to find them in the chatrooms. However, the username search system requires an exact username, and turns up a result even if no user exists under that name. You'd only find out the account doesn't exist once you try to send a message or start a match. Opened chat even though user doesn't exist The Fix The solution I decided on was to allow users to 'Favorite' other users, allowing them to be quickly found later. Toggling favorite/unfavorite The first thing I did was add the '
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 many
Read more