DEV Community

P-DR0ZD
P-DR0ZD

Posted on • Updated on

Open Source Lab 2

In my second lab, I am continuing my work on my SSG. This time we are working with someone else's SSG and implementing reading a markdown file and creating an HTML document with the corresponding HTML tags for example # is the tag

and * is the tag for indenting. For this lab, I also worked with Tong.

Changes to my SSG

My Repo

Tong's Issue

Tong's Request

Tong Added Heading support for my Python SSG. When reviewing it I noticed his HTML wasn't consistent with the format I had done with my previous work so I asked him to fix the issue after that I didn't notice any other issues.

Changes to Tong's SSG

Tong's Repo

My Issue

My Request

For Tong's SSG, I wanted to add two features so I decided I wanted to add the Heading tags and Italics Tags. To begin I needed to understand his code and how his code is formatted so that when I added something to his code it fits and he would be able to understand what it does. I then saw that he had a function that take the text file and send it to another function that would parse a text file. I decided I would remake those two functions but instead add markdown support to them so that when he needs the markdown version rather than the text version he uses the one corresponding to the file type.

In my previous work with Tong, I noticed an issue with files of incorrect types being processed Tong's fix for the issue was for when an incorrect file type was in a directory it didn't include using the incorrect file type on its own so I decided to fix this issue too.

Finally, after Tong reviewed my issue he asked me to document the changes I made so he can understand where I made the changes to his code and what the changes do

Conclusion

Overall I understand how pull requests work with GitHub Much better I now understand that when you make an initial Pull request changes can still be made and that you don't need a new pull request for that.

Top comments (0)