My fouth PR request for Hacktoberfest

 Picking the Issue

I have spent a lot of time finding an issue that I am capable to work on this time. I feel that I am so bad at self-learning. I looked at quite a few issues and tried to work on it but I just can't understand them even I googled and tested a lot. Finally, I gave up on adding a new feather for my fourth pull request. Instead, I decided to contribute to the project mattermost which larger than my previous projects. 

The issue-16167 basically just convert all the file under a component from Javascript to Typescripts. The member of the project also provides the checklist for the migration.

  • < ] Rename the files to their associated TypeScript extensions (ie. js to ts, jsx to tsx)
  •   Update any components using those to the correct imports
  • [ > Fix any errors generated by the TypeScript compiler. You can run make check-types to display any errors
Working on the issue

Firstly, I changed some all 4 files extension from js to ts, jsx to tsx. After I done that, there are a few compile errors show up. Such as:

Parameter 'props' implicitly has an 'any' type.

Property 'serverVersionOnAppLoad' does not exist on type 'Readonly<{}> & Readonly<{ children?: ReactNode; }>'.

roperty 'serverVersion' does not exist on type 'Readonly<{}>'

 After I googled the errors, I noticed that the most difference between Javascript and Typescript is that Typescript is more sensitive to the datatype. I created two interfaces to define the datatype of some variables.

interface IMyComponentProps {
    serverVersion?: string,
}

interface IMyComponentState {
    serverVersionOnAppLoad?: string,
}

then add them into the Class

export default class VersionBar extends React.PureComponent <IMyComponentProps, 
IMyComponentState>

Then, I changed a few variable's data-type using those interfaces. 

I delete the line import PropTypes from 'prop-types';  since typescript no longer need it.

I also changed a function's parameter type from string to string | undefined from another file because a dependency function only takes the string | undefined type. 

Sending pull request

when I sent a draft pull first to check will my code pass all the tests, I got 4 errors that from some formatting. I fixed it and set my pull request to ready for review, it passed all the tests. However, I still have no confidence that my code will actually work because I can not find where is my component (version bar) on the website. After one of the reviewers reviewed my code, I fixed some problems he mentioned, then he approved my pull request. I am still waiting for the merge after the approval. 

Comments

Post a Comment

Popular posts from this blog

My PR for release 0.3 External Project

Image
 Picking the issue I am so glad to hear that we are allowed to work on repositories that  we have already worked on in the past. That means we don't need to spend time on set it up and learn the code. I decide to work on  issue-collab  since I am so familiar with the repository. Different than any other issue I have work on, I filed the new issue-76 myself and tried to create a pull request for it. The issue I filed is that add a scroll to the top button. I am trying to add the scroll to the top button into this issue-collab repository just like the one in Telescope. The owner of Issue-collab thinks this is a good idea too. Working on the issue The first time when I tried to work on it, I just tried to study the code from Telescope and some from google and playing the code around. I was so annoying that I can't put some code together successfully in React. After watched some React video, I realized that there are two different components which are Class components and Function
Read more

OSD600 Lab8

Image
OSD600 LAB8 In this lab, we were asked to add unit tests, code coverage analysis, continuous integration to my open source project  urlStatusChecker .  we were also asked to add Tests to Another project. Choose and Set Up a Testing Framework Since my command-line tool is written in javascript, I choose Jest as my testing framework. It is a famous javascript testing framework that works with projects using: Babel, Typescript, Node, React, Angular, Vue, etc. I  know that Jest contains a code coverage analysis as well, so it is the perfect option. I simply use the command " npm install --save-dev jest " to install it and start writing my unit test. Write My First Test I have never write any unit tests before. After I watched this week's video, I have a basic concept of what is unit testing, integration testing, end to end testing. I chose the  simplest   function  in my project to begin to write my first unit test.  const   goodUrl  = ( urlString )  =>  {    const   PATT
Read more

OSD600 -- Release 0.4.1 -- Choose Project and issues

Release 0.4.1 -- Choose Project and issues For this release 0.4, we keep contributing to the open-source projects with larger/more pull requests. The next couple weeks would be very busy for me and I don't want to spend too much time on finding projects, and setting developer environments, so  I chose to keep contribute to  Telescope  for my last release. I have checked all the issues on the Telescope repository, and I found one I really want to work on Issue-1416  Improve Mobile Usability by adding a bottom app bar Sadly, it was picked by one of my classmates.  However, there are some front-end enhancements/bugs that I can work on.  I will start my release 0.4 by adding/fixing those  enhancements/bugs and keep finding all  related   enhancements/bugs to improve the overall front-end of the project. These are the issues I am currently working on: Issue-1424  Fix font colours in GitHub Contributor component Issue-1426   Scroll To Top button doesn't move to correct position Issue
Read more