Skip to content

Commit 1b9b025

Browse files
authored
Merge pull request #29 from Johnpatrick2/add-blogpost-md
blog post 1 & 2
2 parents 4faec29 + b149eec commit 1b9b025

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

_posts/2025-05-06-jp7914-blogpost.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
layout: post
3+
categories:
4+
- Contribution
5+
author: John Patrick
6+
---
7+
8+
9+
# My First Open-Source Contribution: Improving Documentation for Ramani Huria
10+
11+
## Introduction
12+
13+
Contributing to open-source projects can feel daunting, especially when you're unsure where to begin. This was exactly how I felt when I decided to make my first contribution. I chose to support the [Ramani Huria](https://github.com/RamaniHuria) project because it provides vital geographical data for East Africa, a region that greatly benefits from accessible mapping tools.
14+
15+
As a first-time contributor, I focused on improving the project’s documentation—particularly the `README.md`, which was unclear and outdated. In the process, I gained valuable experience using GitHub and learned how to contribute effectively to open-source projects.
16+
17+
## The Issue
18+
19+
The main issue I addressed was incomplete and outdated documentation. The `README.md` lacked clear installation steps, context for new contributors, and essential project details. Additionally, the repository did not include a `CONTRIBUTING.md` file, which is important for guiding new contributors through the process.
20+
21+
I discovered these gaps by reviewing the repository and its structure. These issues could discourage potential contributors from participating, so I decided to take action.
22+
23+
## How I Overcame It
24+
25+
As someone new to contributing, I initially felt overwhelmed. I was still learning Git and GitHub workflows, such as:
26+
27+
- Forking repositories
28+
- Cloning to my local machine
29+
- Creating branches for changes
30+
31+
To overcome these challenges, I followed GitHub documentation and tutorials to refresh my understanding. Then, I looked at best practices from other open-source repositories to inform my updates.
32+
33+
Here’s what I did:
34+
35+
1. **Forked** the repository to my GitHub account
36+
2. **Cloned** the fork to my local machine
37+
3. **Created a branch** called `update-readme`
38+
4. **Updated the README** with:
39+
- Clear installation instructions
40+
- A project overview
41+
- Goals and contribution tips
42+
5. **Added a new `CONTRIBUTING.md`** file with:
43+
- Step-by-step instructions on how to contribute
44+
- Forking, branching, committing, and pull request guidelines
45+
6. **Committed and pushed** the changes
46+
7. **Opened a pull request (PR)** to the main repository
47+
48+
Although the PR hasn’t been reviewed yet, the process was a significant learning experience for me.
49+
50+
## Conclusion
51+
52+
This experience taught me the value of clear documentation and the importance of community support in open-source development. I now feel more confident using Git and GitHub, and I understand how impactful small contributions—like better documentation—can be.
53+
54+
Contributing to Ramani Huria not only improved the project’s accessibility for new developers but also boosted my confidence as an open-source contributor. I'm excited to continue learning and contributing to other projects in the future.

0 commit comments

Comments
 (0)