Introduction
For release 0.3 in DPS909, we had a few parts that we needed to accomplish in the assignment. This blog post will discuss my experience with contributing to an internal repository. The repository of choice was IPC144.
To find out what exactly the IPC144 repository is, click this link.
The issue
The issue that was brought up in this internal repository, was to
audit the style-guidelines.md file. There is a very specific checklist that we had to abide by, to ensure that our audit was done correctly.
Here is the link to the issue: ISSUE-49
The PR
So, I began my journey of auditing style-guidelines.md.
Setup
The setup for the IPC144 was super straight forward. It utilizes Docusaurus. I followed the steps in the Contributing file, and was able to get it up and running quickly. By doing so, I was able to get quick reload, meaning that any changes that I would make, would be instantly reflected on the localhost.
The Audit
The audit was rather simple. I followed each item in the checklist, and would go through and ensure that the selected item was done correctly. This included items such as checking for typos, ensuring the Markdown elements are converted correctly, using code blocks for syntax highlighting, etc.
Here you can find my PR:
https://github.com/Seneca-ICTOER/IPC144/pull/92
The Conclusion
Overall, this internal issue was simple, however, it introduced me into the world of auditing pages to ensure that they are done to the highest quality. Following the checklist made my journey a ton easier, and in the end I had a high quality markdown file.
Top comments (0)