Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# 📝 Pull Request Template

Thank you for contributing to **Open Source Learning Stories**! 🎉
Please make sure your PR follows the guidelines below.

---

## ✅ Checklist

- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md).
- [ ] My story is added inside the `stories/` folder.
- [ ] The file is named correctly: `your-name.md`.
- [ ] I used the proper story format (Name, Date, Tools, Experience, Advice).
- [ ] I did not edit or delete someone else’s story.
- [ ] My contribution is genuine and respectful.

---

## 📖 Description

Please provide a short description of your contribution:

(e.g., “Added my open-source journey story,” “Fixed typo in example-story.md,” etc.)

---

## 📂 Related Issue (if any)

Closes # (issue number)

---

## 🚀 Screenshots / Preview (Optional)

(Add a screenshot if relevant, e.g., before/after changes in docs or design)

---

💡 *Tip:* Keep your PR small and focused on one change. It makes reviewing easier. 🙌
30 changes: 30 additions & 0 deletions .github/add-story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: "📖 Add My Story"
about: Use this template to request adding your open-source journey
title: "[Story] Add my story"
labels: story, hacktoberfest
assignees: ''
---

## 👤 Contributor Details
- **Name:**
- **GitHub Username:**

---

## 📖 Story Details
- **First Contribution (Month/Year):**
- **Tech/Tools Used:**
- **Short Summary (3-5 lines):**

---

## ✅ Checklist
- [ ] I will add my story under the `stories/` folder.
- [ ] The file will be named as `your-name.md`.
- [ ] My story is genuine and respectful.
- [ ] I understand spammy PRs will not be accepted.

---

📌 *Note:* You can directly create a PR instead of raising an issue, but this template is here for those who prefer guidance. 🚀
59 changes: 59 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# 🤝 Contributing to Open Source Learning Stories

First off, thank you for taking the time to contribute! 🎉
This project is all about **sharing your journey in open source** so others can learn and get inspired.

We welcome all kinds of contributors – beginners, students, professionals, writers, and creators.
You don’t need to be a developer to add value here. 🚀

---

## 🛠 How to Contribute

1. **Fork the repository**
Click the **Fork** button at the top right of this repo.

2. **Clone your fork**
```bash
git clone https://github.com/<your-username>/open-source-learning-stories.git

3. **Create a new branch**
```bash
git checkout -b add-my-story

4. **Add your story**
- Go to the stories/ folder.
- Create a new file named:
- your-usename.md
- Follow this format:**


# My Open Source Journey ✨
```
Name: Your Name
First Contribution: Month Year
Tools/Tech Used: e.g. Python, FastAPI, GitHub
My Experience: (Write 5–10 lines about your journey)
Advice for Beginners: (Share one tip)
```
5. **Commit your changes**
```bash
git add stories/your-name.md
git commit -m "Added my open source story"

6. **Push to your fork**
```bash
git push origin <your-branch-name>

7. **Create a Pull Request (PR)**
- Go to the original repo.
- Click New Pull Request.
- Submit your PR for review.

### ✅ Contribution Rules
- Don't Push to Main or develop branch
- Keep stories respectful and beginner-friendly.
- Use Markdown format only.
- No spammy PRs – make sure your story is genuine.
- Add only your own story (don’t edit/delete others).
- English is preferred, but translations are welcome.
Binary file added assets/image1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions stories/example-story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# My Open Source Journey ✨

👤 **Name:** Jane Doe
📅 **First Contribution:** October 2023
🔧 **Tools/Tech Used:** Python, GitHub, Markdown

🌟 **My Experience:**
I started my open-source journey during Hacktoberfest 2023. At first, I was nervous about contributing because I thought I needed to be an expert in coding. But then I discovered projects that welcomed **non-code contributions** like improving documentation, writing tutorials, and designing simple graphics.

My first PR was fixing a small typo in documentation – and it got merged! That moment gave me the confidence to contribute more. Since then, I’ve shared tutorials, written blogs, and even translated README files into my native language.

📌 **Advice for Beginners:**
Don’t wait to be “perfect” at coding. Start small – fix a typo, write a blog, or share your story here. Every contribution matters in open source! 🚀