Intro...
This week, I worked on my fourth and final commit of Hacktoberfest. Because I had a lot to do with exams, projects, and personal projects over the reading week, I didn't want to delve into a major fix. Instead I opted for something new that wasn't the most complicated but is still something I had to get my self familiar with. I found a project, the Code Thesaurus located at https://codethesaur.us and I saw they had an open issue to help with adding some Kotlin syntax to the thesaurus.
The issue ...
The issue I worked on pertained to adding Kotlin syntax for input and output operations in the thesaurus so they can be compared to the implementations of other languages.
The issue I contributed to can be found here:
https://github.com/codethesaurus/codethesaur.us/issues/736#issue-2436514141
The fix ...
To prepare the fix I had to setup the environment of the project. It was well documented and easy to setup by just following the commands given.
The steps I took were as follows:
- Reviewed the issue
- Created a fork to ensure it was something I was familiar with
- Set up the project
- Looked where the fix was supposed to be located and ensured I would be good to fix this.
- Asked and waited for approval
- Ran the server / application
- Begun implementation
Same process as the previous PR's.
In order to prepare and actually make the fix, I continued with my scoping out the project to ensure familiarity with the language and framework setup to ensure that this was a change I was comfortable working on.
Code ...
The code for my fix was editing JSON formatted data. It was not too much, it was just writing values for "code", "comment", "name", and other values or JSON data.
The code was less than I expected, but I had to do a lot of research on the side, as I was uploading documentation for Kotlin, which I have no previous experience in. I had to thoroughly research Kotlin and its syntax in order to ensure correctness and provide accurate descriptions for each code snippet I provided.Code of io.json before the fix:
N/A, file did not existExample Code of io.json after the fix:
In the new code you can see that I only had to work with formatting json data this time around, implementing code examples, comments if needed, and a description of the code to be compared.
Difficulties ...
This project did not cause me any prior research and/or major difficulties to setup as it was well documented and ran easily on my PC. However my only difficulties came with ensuring my Kotlin code was good and working.
Maintainers ...
Overall I had little interaction with maintainers up until the pull request, only having spoken about confirmation regarding the issue to be assigned.
PR ...
My pull request for this week's post can be found here:
https://github.com/codethesaurus/codethesaur.us/pull/762#issue-2627255281
Top comments (1)
Great job completing Hacktoberfest! It's awesome you chose to learn Kotlin and contribute to the Code Thesaurus. Looking forward to seeing your PR when it's uploaded.