Skip to main content

Hacktoberfest - Pull Request #1 : RawCMS Documentation

In my previous post, I announced my participation in this year's Hacktoberfest event and explained the event along with my goals to succeed in it. Be sure to check out the post if you haven't already, it will provide some context for this one. This post will detail my successful first pull request to the RawCMS project along with some information about the project itself. I will also include my next steps to progress as an open-source contributor.  The pull request was reviewed and approved by the project creator, and I was invited to continue contributing to the project by the creator.

RawCMS

CMS stands for Content Management System, and as it's name suggests, it's simply a tool to allow website owners to manage the content of their site without having to hard-code the content into the HTML code of the site. RawCMS is a 'headless' CMS, meaning it allows the user to manage the content of the site by storing it all on a MongoDB based backend, and then the content can be plugged into any or multiple front-ends that user wishes. The documentation describes it as, "a headless CMS written in asp.net core build for developers that embrace API first technology."

This caught my interest because in my earlier days, before even starting my post-secondary education, I had worked with a popular CMS known as a Wordpress. While it wasn't a headless CMS, I was curious to see how a headless one like RawCMS would benefit a developer with front-end experience such as myself. This led me to continue reading their documentation, and this is where I encountered the issue I ended up raising.

The Issue - Poor Syntax in Documentation

As I was reading the ReadMe file to familiarize myself with the project, I came across several spelling mistakes and grammar issues that made it somewhat painful to read. These issues not only compromise the reader's experience, but can also hinder the reader's comprehension of the information the documentation wants to convey. My guess was that the creator of this project is not a native English speaker, so I felt like my proficiency in English can definitely help improve the documentation. I took it upon myself to create an issue regarding the spelling and grammar mistakes.

The Enhancement

After forking the repo, I began enhancing the documentation. This involved correcting the spelling mistakes and restructuring some of the sentences to improve clarity and precision. I also replaced some awkwardly worded phrases.

Screenshot of Corrections #1

The Pull Request 

After completing the enhancements and corrections, I created a pull request to merge my "fixedReadMe" branch with the master branch of the original repo. After roughly one day, my changes were reviewed, approved and merged. I also received a positive message from the project creator encouraging me to continue contributing to the project.

The Next Steps

As a novice, my plan was to ease myself into open source. It's safe to say I did exactly that, since the difficulty of the project was not too high. I simply leveraged my proficiency of the English language to contribute to a project's documentation. My next steps are to actually add some functionality to a project, which would involve a process of familiarizing myself with the code to a certain extent before being able to contribute.

I'm eager to take my next steps and progress as an open-source contributor. 

Stay tuned for the next pull request in about one week!


Comments

Popular posts from this blog

Release 0.3 - Pull Requests Telescope & LifeStyle Ecommerce

In my previous post, I revealed the issues I will be attempting to resolve in order to contribute for an internal project and an external project. I also detailed the projects themselves, so if you haven't already read my previous post, I would advise starting there to give my current post some context.

I can successfully say I reached the goals I set for both the external and internal project in my previous post. Keep reading to find out how I did this, and the challenges I overcame.

Internal Pull Request Adding Pagination to CDOT Telescope
This issue was assigned to me by a colleague and was much trickier than I initially anticipated. The issue simply required to implement paginating functionality to the front end, so that the blog posts are displayed in pages instead of all  being displayed in one very long scrollable feed.
The first challenge came with the starting point. The home page was designed with a very specific bootstrap library (MD Bootsrap) that had some different con…

Hacktoberfest - Pull Request #3 : Improving Rhymus' UI

In my previous post, I announced and explained my second pull request for this year's Hacktoberfest event, where I added puzzles to Rhymus, a web based word-puzzle game designed to improve a users vocabulary.


The Project: Rhymus

If you have already read my description of Rhymus in my previous post, you can go ahead and skip to "The Issue" section.

Rhymus is an open-source web based game written in HTML, CSS and Javascript. It presents the user with word based puzzles to help users improve their vocabulary and familiarity with some common expressions, Phrases and/or common expressions are shown with on of the words being replaced with a rhyme for the original. The user must input what the correct word is, and has the option to take a hint for less point. The game has a scoring system to measure the users success. All in all, I found it to be a fun project that would be very helpful for those looking to expand their vocabulary. I can see it being useful for foreign…

Micro-Note : My First Steps into Open Source

I just finished building Micro-Note, a simple web based note taking application. While it is not the most innovative app, it marks my first steps into the world of open source. Not only was I able to learn and exercise essential Git skills including the creation and operation of a repo, but also brush up on my web development basics. This involved both features found on the GitHub web app, and the Git command line interface. I found this highly useful as I am aware Git will be a part of my career moving forward, whether it be for open source or other ventures as a developer.

The app is simple and fairly self explanatory.  It allows the user to input notes into the web page and save them to continue or edit them later if needed. It is built with the standard web stack, HTML5, CSS, and JavaScript. It uses the FilerJS Browser Filesystem libraryto save the user input to a local file so the user can save and resume their note-taking at later time.  This was helpful as it allowed me to brus…