For week two, I had to spend less time searching for an issue. This time it was a bug that occurred in dark mode for a documentation website for Mattermost, where a specific button would be the incorrect color.
I am aware of Docusaurus, since I have seen other documentation and some of our course material site built on it. Under the hood it uses React so I was familiar with it. But this documentation website was written in Python. Although I'm not a fan of Python, it intrigued me, since not only it is written in python, more specifically using Sphinx which utilizes reStructuredText as its markup language. There was Makefile in it as well. A lot of new things but it looked very interesting.
So I wanted to work on the issue. After expressing my interest and getting the issue assigned to me I started working on it. Although the setup process is very straight forward, with scripts automating most of it, I had slight issue. I use WSL(Windows Subsystem for Linux) as my dev environment. Although I have both I have both python version 2.7 and 3.10 in WSL I was having trouble setting it to 3.10 as my default version and since I need Python 3.9 or later to setup the application I was getting error. So I after doing some investigation and finding out culprit I switched to my native windows environment. After that it was smooth sailing. I was kind of surprised how long the entire compilation time was. It took surprisingly long and I suspect python is to blame. Making adjustments for styling for the specific button in conf.py, I had to recomplie and the issue seemed to be fixed.
So my next step was to make a PR. While writing PR description I saw there was links to the Mattermost website for contributing guidelines, so I had to register and sign documents to be able to contribute and have my github account show up as contributor. I was read the guild lines for make proper PR. After going through everything I made the PR and then is the wait time. As of writing this the PR is still open, even after 5 days. After having my code review accepted, there had to be a QA which took the longest. And as of writing this both code review and QA has been done so it's only a matter of time its merged and closed.
For week 2, it was pretty fun and interesting to work on a company repo and seeing the entire process unfold. Although the project is in python it was surprisingly easy to work on it.
Top comments (0)