diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..6e1b85c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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. πŸ™Œ diff --git a/.github/add-story.md b/.github/add-story.md new file mode 100644 index 0000000..9f51e38 --- /dev/null +++ b/.github/add-story.md @@ -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. πŸš€ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..67a0d62 --- /dev/null +++ b/CONTRIBUTING.md @@ -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//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 + +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. \ No newline at end of file diff --git a/assets/image1.png b/assets/image1.png new file mode 100644 index 0000000..8f47de3 Binary files /dev/null and b/assets/image1.png differ diff --git a/stories/example-story.md b/stories/example-story.md new file mode 100644 index 0000000..97cc281 --- /dev/null +++ b/stories/example-story.md @@ -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! πŸš€