Hi everyone,
This week, I worked with a partner (rokaicker) to improve both of our SSG tools. We connected through Slack.
Reviewing Rohan's code was very pleasant and enjoyable because his code was well documented and easy to understand. His logic made sense and I had no problems with his code.
I was glad that he reviewed my code and added issues to my repo, because I wasn't the most confident in my code. He pointed out a few great things I should've added to my tool. Also he pointed out an issue that I wouldn't have noticed since I am colour-blind.
Some issues I had were nit-picky, like better formatting. However, there were some installation issues that I had. For example, I couldn't run the tool without using node before the command name. Apparently, this was a Windows only issue, since my partner was testing using a Linux terminal. Other issues related to the generated HTML files not creating the title properly and missing spaces.
The issues I filed:
Installation does not work out of box - After following the installation instructions, the node_module folder with required modules is not installed.
The -v and --version options are missing information - The version option should also print out the tool's name.
Spaces are missing in the HTML file - There were multiple places where a space is missing from the HTML file.
Title and header are incorrectly created in some cases - The HTML files are not created properly if there are 2 new lines found in the text file somewhere not after the first line.
Cannot run the rohan-ssg command directly on a Windows terminal - Cannot run the tool with the rohan-ssg command directly on a Windows terminal.
Better formatting for HTML files - Generated HTML files contain extra whitespace and <p> tags are all put into 1 line. Could be formatted better.
The issues my partner filed:
node_modules shouldn't be committed in git - The node_modules folder should not be in the repo due to possible conflicts on different OS's and potentially commiting dev dependencies along with project dependencies.
inability to specify direct path to a separate folder - Users could not specify a file nested in a folder. For example: "./Sherlock-Holmes-Selected-Stories/Silver Blaze.txt"
need to add "node" to the beginning of the command - Running the tool without having to use node before the command.
possibly change stylesheet colors for less eye strain - Changing the colour scheme for the default stylesheet.
Duplicate variables - Duplicate variable in code.
I was able to fix all my issues. Rohan was clear in his issues and provided pictures/examples, so it wasn't too difficult.
I learned that testing and reviewing is extremely important for developing the best code. It is easy to miss things when you're the only one working on your code.
Top comments (0)