Skip to content

README.md

Latest commit

 

History

History
280 lines (181 loc) · 8.38 KB

README.md

File metadata and controls

280 lines (181 loc) · 8.38 KB

🌟 Good First Issue - Your Open Source Journey Starts Here!

Open Source Love PRs Welcome First Timers Only Contributors

Welcome to the most beginner-friendly open source project! 🎉

This project exists for one reason: to help YOU make your first contribution.

🏠 Home | ⚡ Quick Start | 🤝 Contributing | 💬 FAQ | 📚 Resources

📖 About This Project

This is a training ground for aspiring open source contributors. By adding your name to our hall of contributors, you'll learn the entire GitHub workflow that powers millions of open source projects worldwide.

What You'll Learn

  • ✅ How to fork a repository
  • ✅ How to clone code to your computer
  • ✅ How to create a branch
  • ✅ How to make changes and commit them
  • ✅ How to push code to GitHub
  • ✅ How to create a Pull Request (PR)
  • ✅ How to collaborate with other developers

Why This Matters

These skills are the foundation of open source contribution. Once you complete this, you'll be ready to contribute to any project on GitHub!

🚀 Getting Started

Ready to make your first open-source contribution?

We have moved the complete onboarding tutorial into dedicated documentation:

The Quick Start guide covers:

  • Forking the repository
  • Cloning your fork
  • Creating a branch
  • Making changes
  • Committing and pushing
  • Creating a Pull Request

Follow the guide and come back here once your contribution is merged!

👥 Contributors

These amazing people have completed their first contribution! 🎯

Auto-updated on every merged PR via GitHub Actions

🥇 Champions — 5+ PRs

Contributor PRs Merged
Be the first Champion! --

🥈 Regulars — 2–4 PRs

Contributor PRs Merged
Keep contributing to unlock this tier! --

🥉 First Timers — 1 PR

Contributor PRs Merged
Adit 1
Adithya S 1
Aditya Singh Rathore 1
Janvee 1
Mudradi Pranavi 1
Rita Huang 1
Yash Singhal 1
Parth Bhuptani 1
Pranav M S Krishnan

💡 Every merged PR counts — keep contributing to climb the tiers! Full details in CONTRIBUTORS.md

Your name will appear here once your PR is merged!

🆘 Stuck? Get Help!

Common Issues & Solutions

❌ "Git is not recognized" or "command not found"

Solution: Git isn't installed. Download it from git-scm.com and restart your terminal.

❌ "Permission denied" when pushing

Solution: You might not have permission to push to the original repo. Make sure you:

  1. Forked the repository first
  2. Cloned YOUR fork, not the original repository
  3. The URL should contain YOUR username
❌ "Merge conflict" in Pull Request

Solution: Someone else added their name in the same spot. Don't panic!

  1. Pull the latest changes: git pull origin main
  2. Fix the conflicts in README.md (remove the <<<<, ====, >>>> markers)
  3. Add and commit: git add README.md && git commit -m "Fix merge conflict"
  4. Push again: git push origin add-your-name
❌ My terminal/command prompt doesn't work

Solutions:

  • Windows: Use Git Bash (installed with Git) or PowerShell
  • Mac: Use Terminal (find it in Applications > Utilities)
  • Linux: Use your default terminal (Ctrl+Alt+T)
❌ I made a mistake in my commit

Solution: You can fix it!

  1. Make the correction in README.md
  2. Stage: git add README.md
  3. Amend the commit: git commit --amend -m "Add [Your Name] to contributors list"
  4. Force push: git push -f origin add-your-name

Still Need Help?

  1. Search existing issues: Someone might have had the same problem
  2. Open an issue: Click "Issues" → "New Issue" and describe your problem
  3. Include details: What command you ran, what error you got, your operating system

We're here to help you succeed! 💪

🎓 What's Next?

Congratulations on your first contribution! Here's how to continue your journey:

Level Up Your Skills

  1. Make Another Contribution

    • Try adding a resource link to the "Resources" section
    • Fix a typo you noticed
    • Improve the documentation

  2. Explore More Beginner-Friendly Projects

  3. Learn More About Git & GitHub

Contribute to Real Projects

Now that you know the workflow, you can contribute to ANY project on GitHub! Look for:

  • Issues labeled good first issue
  • Issues labeled beginner-friendly
  • Issues labeled help wanted

📚 Learning Resources

Git & GitHub

Open Source

Practice

🤝 Contributing Beyond Adding Your Name

Want to help improve this project? Here are ways to contribute:

  • 📝 Improve documentation clarity
  • 🌍 Translate to other languages
  • 🐛 Fix typos or broken links
  • 💡 Suggest improvements via issues
  • 🎨 Improve formatting or add helpful diagrams
  • 📹 Create video tutorials

Check CONTRIBUTING.md for detailed guidelines.

📜 Code of Conduct

We are committed to providing a welcoming and inclusive environment. Please read our Code of Conduct to understand our community standards.

In short: Be kind, be respectful, be helpful. We're all learning together! ❤️

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🌟 Support This Project

If this project helped you start your open source journey:

  • ⭐ Star this repository (top-right corner)
  • 🔗 Share it with friends learning to code
  • 🐦 Tweet about your first contribution with #MyFirstPR
  • 📢 Spread the word in your coding community

💬 Community

Join the conversation and connect with other contributors:

  • Have questions? Open an Issue
  • Want to discuss? Start a Discussion
  • Share your success! Tag us when you share about your contribution

Made with ❤️ for beginners by beginners

Remember: Every expert was once a beginner. You've got this! 💪

⭐ Star this repo | 🔀 Fork it | 🤝 Contribute