DEV Community 👩‍💻👨‍💻

a-parris21
a-parris21

Posted on

Release 0.2 - PR #3

Issue I worked on

I worked on the html.org.in project once again.

When I was working on my second pull request, I found it very difficult to read the project's README.md file. The instructions were not very clear to me and there were moderate grammar errors througout the document.

So, I opened an issue, #70, to make some imrpovements to the project's README.md.

Preparation for the fix

There was not much preparation required for this fix apart from my usual workflow actions - i.e. forking the repo and making a branch for the issue.

Code Explanation

There was no code involved in this fix. I provided documentation improvement to the repository for this PR.

As such, I've provided URLs to the repo's README.md file prior to my changes and also after my changes.

Before the fix

This is the original README.md file from before my changes.

After the fix

Here is the README.md file after my changes.

Research

As this was a documentation improvement, minimal research into programming topics was necessary.

I did some reading on embedding video files in webpages via HTML and compared my research material to the instructions provided in the project's documentation just to ensure I was understanding code correctly.

Interactions with project maintainers

I did not have any notable interactions with the project maintainers.

Difficulties

Improving the documentation was difficult at first since I found it very unclear initially. However, as I familiarized myself more with the project, it became clearer to me what the developers were trying to say in the README.md.

Link to Pull Request

PR #73

Top comments (0)

Want to Create an Account?
Now it's your turn!
 
🗒 Share a tutorial
🤔 Reflect on your coding journey
❓ Ask a question

Create an account to join hundreds of thousands of DEV members on their journey.