DEV Community

Gustavo Tavares
Gustavo Tavares

Posted on

The Last Hacktober PR

The Project

jira-remote-link-action.
From their Read Me:
“This action creates remote links in Jira from the issue keys found in GitHub Issues.”

The Issue

Issue #5.

For this PR, my task was to throw an error if the request was unauthorized. Looked easy at first glance.

The hard part of this issue was to find it, the project has almost 6500 lines of code in a single file, plus the author didn’t gave much information on where to find it, so I had to read it and understand how it works in order to fix it.

Documentation

This brings me a topic to the mind, the importance of documenting the code well and splitting it in many parts to make the life of the other people that will maintain your code easier.

Top comments (0)