Open Source Basics
Tags: opensource, javascript, java
Published: 2022-09-16 13:27:56

##LAB 1

- How did you go about finding someone to work with?

I reached out and asked if anyone was doing their project in java.

- What was it like testing and reviewing someone else's code? Did you run into any problems? Did anything surprise you?

It was somewhat challenging, though I wouldn't call it a bad thing. Ran into a few problems running the commands but easily fixed.

- What was it like having someone test and review your code? Were you surprised by anything?

This is the first time I let someone other than a professor take a look at my code. I was surprised at first, but gradually got used to it as the week went on. 

- What kind of issues came up in your the testing and review?  
- _Discuss a few of them in detail._

I have found several issues, nothing too bad, just a couple of errors that need debugging, and several visual errors that could easily be fixed. Though one of which completely broke the entire program. It was more specifically the optional `--output` command.

- Provide links to issues you filed, and discuss what you found

**[Issue 1](https://github.com/Genne23v/wk-ssg/issues/1)**:
`--help` when run in the command line is somewhat clustered up. Add new line in order to display as a proper list. Simple display issue that can easily be fixed

**[Issue 2](https://github.com/Genne23v/wk-ssg/issues/2)**:
`README.md` Could be more clear when it comes to using the commands. Give an example of how the command should look like when it runs. Because I have tried running the file through and it says that it cannot be found. State that it requires quotation marks around the file or folder name in order to run properly. 


**[Issue 3](https://github.com/Genne23v/wk-ssg/issues/3)**:
When inputting a non .txt file, the file that's not .txt will also be converted into an HTML file. Tested with a markdown file, and it also converted the markdown file into a .txt file

**[Issue 4](https://github.com/Genne23v/wk-ssg/issues/4)**:
Several Bad Values when put through `https://html5.validator.nu/`, in the main HTML website. All the errors are on the main page. 

**[Issue 5](https://github.com/Genne23v/wk-ssg/issues/5)**: 
When running the -o option incorrectly a warning pops up. When running an -i command directly after, it will not put the converted files in the created folders nor the ./dist folder. Only an error will pop up. When trying to re-override the folder, it will also show an error.

- Provide links to issues that were filed on your repo, and what they were about

**[Issue 1](https://github.com/LostButton/my-button-ssg/issues/5)**:
Minor typo to download yargs. changed the README.md file to say `npm i yargs`

**[Issue 2](https://github.com/LostButton/my-button-ssg/issues/4)**: 
Minor alteration, adding indents to the HTML formatting in order for output to look better.

**[Issue 3](https://github.com/LostButton/my-button-ssg/issues/3)**:
Optional `--ouput` function output does not work properly.

**[Issue 4](https://github.com/LostButton/my-button-ssg/issues/2)**
Forgot to add node in front of command in order for the command to work. Modify `README.md` to change it to proper node command. 

**[Issue 5](https://github.com/LostButton/my-button-ssg/issues/1)**:
Unavailable option can be taken as an argument in the command line.

- Were you able to fix all your issues? What was that like?

I was able to fix most of the issues, and it wasn't that bad. Modifying the results was a simple task. Most of the issues are fixed. Though the one I couldn't really wrap my head around to fixing was just issue 5. Until I realized the `-i` command was set as my default.

- What did you learn through the process of doing the testing and reviewing?

Overall it was a new experience in this lab, as I got to use GitHub issues for the first time. Considering this is the first time I was told to intentionally break someone's code and look for bugs. Though this shows and solidifies in my mind why testing code is so important, and getting feedback from external sources can be important.