Lab 7 Blog

    In Lab 7 we went back to our Release 0.1 link checker project and worked on creating a CONTRIBUTION.md file, source code formatter, linter, and an integration method for the said code formatter and linter. 

    The contribution file is added for the purpose of guiding Github users that visit our repositories the way to set up the project locally and help them get a headstart with their pull requests, in that file we will also be discussing how to develop & use the program as well as formatting and error checks.

    Since my project was made using Javascript, I chose Prettier and ESLint for my formatting and linter. Prettier was installed using the step by step instructions on their official website through CLI, initially there was a problem with the .prettierrc.json file for it was generating errors when trying to run the prettier command. This problem was fixed by manually creating the file instead of using their echo command. Prior to installing Prettier, my code's format was spread out and too spacious, but after the code's format became more organized and concentrated, making it easier to read through the entire file.

    ESLint was installed using their website after Prettier, it was able to find 15 errors that had to do with formatting and code quality, most of the errors came from unused parameters, regex expression, and repeated variable creation. I fixed some of the errors but chose to leave the regex expressions unchecked because it risks breaking the code.

    
To integrate both features into a local editor like VSCode, you simply install the extension from VSCode's tab after installing both features.
This week made me realize how useful these tools can be when it comes to open source development, it will keep everyone's code clean and formatted the same way, preventing any messy codes to surface on the repositories.
        




        

Comments

Post a Comment

Popular posts from this blog

Lab 2 Blog

     Today I contributed to another user's project on GitHub , I wanted to work on a feature where it counts how many times each type of HTTP status code as well as URLs in total has been checked, and then display it as a result section of the output.      First I sent out an Issue on his repository regarding what I wanted to do and proposed to work on it myself. After I finished adding my feature, I issued a pull request to the person's repository as I wait for feedback.      During the making of the Result Counter feature, I started by creating variables to hold all the counters and display messages. Then, I put the counters inside the loop that determines the status of the URLs, counting each and every time the if statement was valid. The total amount of URLs are added each time the loop had completed. One major problem I came across while making this feature was the fact that the result message were displayed before the list of URLs were outputted, the only way for me to
Read more

Lab 4 Blog

     This week's lab consisted of going to a new user's repository that we haven't worked on before, and add a new feature called "Ignore URL Patterns" onto their Release 0.1 repository. This feature will be activated after a new argument '--ignore' had been received, containing the ignore argument will allow the CLI tool to read two files in order: the file that contains the list of URLs that will be ignored by the link checker, and the argument after that will be the targeted file to scan.     I created an Issue on another person's Repository , and once I got permission to work on the issue, I Forked the repository into my own and cloned that forked repository into my local machine. I ran through the code and got a better understanding of how the code works before working to add the feature in.     After the feature had been completed, I contacted the owner of the project through the issue that was opened to let him know that I had finished the fea
Read more

Release 0.4

     The final assignment is finally here, it is almost time to say goodbye to this semester. Throughout the semester, we've done many different things and was involved in several open-source projects where we learned and overcame problems. This is the best course to explore Github and get some hands-on experience with programming, the open-source community is vast and filled with professionals that you can work with as well as learn from.     For the final assessment, I'd like to work on a feature that I've never touched before to prove that I did indeed grow as a programmer from taking this course. I decided to work on a repository that had started contributing to since Release 0.2, qasong . I picked this because they are a project that is near launch and I grew to like their team's effort as well as what they do, I definitely learned a lot more about React by contributing.      I am currently contemplating on taking an old issue that was never taken since September,
Read more