badge-generator VS glazed-donut

I use a workflow similar to the one above that is implemented in my Badge Generator web app, which is built in Vue and Yarn.

Looking through my classmates' contributions for Hacktoberfest, I found badge-generator - a cool tool that helps us create markdown badges for our documentations. The owner wants to implement the dark mode for the site, and since the tool is written with VueJS, I decided to challenge myself as I could also continue to learn this framework.

Eventually, I remembered one of the repos that I've used before to contribute to one of the Hacktoberfest issues, I thought that it would be nice to give back (hint hint😉😉😉 something to think about when looking for an issue... hint😉) to that repo. I quickly gave up everything I was doing and went to check it out to see if it is even active and if it has any open issues I could work on. To my surprise, no one except the author has ever contributed to that before, so I am now officially one of the first contributors there.😋

After browsing for a while, I found MichaelCurrin's project, badge-generator. The project is a simple interface for simplifying the creation of badges, used in several open source projects to show things like the version number of the project, whether the project is currently building, etc. A badge usually looks like this:

I learned was that even if an issue seems small and something that you can handle, it doesn't mean you will not learn a lot out of it. During the process, I learned about a handy open source repo that helps to generate badges to make README files look prettier. And a cool tool that has all the emojis you need for your frontend.

badge-generator

For the past week, I have been researching on where to release my command line interface (cli), glazed-donut.

For this week, I set up a CI pipeline for yassgy with GitHub Actions. I also contributed to glazed-donut, by creating a few test cases.

Throughout the last months while I was working as a Software Developer Intern and on my my ssg repo, I was hardly ever touching front end. I missed working on front-end a lot, so as my first PR for the #hacktoberfest challenge, I decided to take on a small issue related to front end.

This week I was doing some refactoring for my glazed-donut repo. Since its creation, the features kept coming in every week, but there was no refactoring done whatsoever, so... it got pretty messy😅

This time, I've added two features for Glazed-Donut. It now supports the --lang (or simply -l) command, where you can specify a language tag (ex: fr-CA for Canadian French) and it will set the lang attribute in the generated HTML files to whatever value you put. By default, it will set the lang attribute to en-CA. It is done so that the browser can know what language the contents of the file are, and how it can better interpret them.

Irene also added a similar feature to my glazed-donut repo. The feature she has added was a Markdown file support that's able to convert all # into

After I built the Glazed Donut, I had a wonderful opportunity to explore a similar project shinny-ssg by doing some testing and reviewing and get my glazed-donut tested as well.

I tested her application glazed-donut with all test cases and her code nailed it. All the features worked as expected and it generated appropriate messages to the users when there were any errors/exception. The only problem I could find about it is in generateHTML method , which she should have replaced the with white space. Other than that, just a few minor typos on the read me file, but nothing major. When she reviewed my code and tested my app, I appreciated that she really spent the time to check every detail, giving me very sound advice and helped me file bugs which I did not find before. First, she mentioned the naming convention in C# and explained in details the good practices in the industry. Second, she found a bug in my Page class which created an extra tag. Third, my exception handling was not good enough and she guided me to make it better. In the end, I am able to fix most of the issues but I need more time to improve the code and make it flawless.

You can view the project here.