Skip to content

About

A beginer friendly repository that tends to make user learn about the basics of open source contributions

Resources

Code of conduct

Contributing

Stars

1 star

Watchers

0 watching

Forks

Β 
Β 

Latest commit

Β 

History

39 Commits

Folders and files

Repository files navigation

🌟 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.

Detailed Guide | Help | What's Next


πŸ“– 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!


πŸ“š Detailed Step-by-Step Guide

Step 1️⃣: Fork This Repository

What is forking? Creating your own copy of this project in your GitHub account.

  1. Click the "Fork" button at the top-right of this page
  2. Wait a few seconds while GitHub creates your copy

Fork Button Location

βœ… Success Check: You should now be on github.com/YOUR-USERNAME/Good-first-Issue


Step 2️⃣: Clone Your Fork

What is cloning? Downloading the code to your computer so you can edit it.

  1. On your forked repository, click the green "Code" button
  2. Copy the URL (should look like: https://github.com/YOUR-USERNAME/Good-first-Issue.git)
  3. Open your terminal/command prompt
  4. Navigate to where you want to save the project (e.g., Desktop):
    cd Desktop
  5. Clone the repository:
    git clone https://github.com/YOUR-USERNAME/Good-first-Issue.git
  6. Navigate into the project folder:
    cd Good-first-Issue

βœ… Success Check: Run ls (Mac/Linux) or dir (Windows). You should see files like README.md


Step 3️⃣: Create a New Branch

What is a branch? A separate version of the code where you can make changes safely.

git checkout -b add-your-name

Pro Tip: Replace your-name with your actual name (e.g., add-john-doe)

βœ… Success Check: You should see: Switched to a new branch 'add-your-name'


Step 4️⃣: Add Your Name

  1. Open README.md in your text editor
  2. Scroll down to the "πŸ‘₯ Contributors" section
  3. Add your name following this exact format:
    - [Aditya Singh Rathore](https://github.com/Adez017)

Example:

- [John Doe](https://github.com/johndoe)
  1. Save the file (Ctrl+S or Cmd+S)

⚠️ Common Mistakes to Avoid:

  • Don't forget the - at the start
  • Don't forget the square brackets [] around your name
  • Don't forget the parentheses () around your GitHub URL
  • Make sure the URL is YOUR GitHub profile (replace YOUR-USERNAME)

Step 5️⃣: Commit Your Changes

What is a commit? Saving your changes with a description of what you did.

  1. Check what you changed:

    git status

    You should see README.md listed in red.

  2. Stage your changes:

    git add README.md
  3. Commit with a message:

    git commit -m "Add [Your Name] to contributors list"

    Example: git commit -m "Add John Doe to contributors list"

βœ… Success Check: You should see a message like 1 file changed, 1 insertion(+)


Step 6️⃣: Push to GitHub

What is pushing? Uploading your changes from your computer back to GitHub.

git push origin add-your-name

Remember to use the branch name you created in Step 3!

βœ… Success Check: You should see Branch 'add-your-name' set up to track remote branch


Step 7️⃣: Create a Pull Request

What is a Pull Request (PR)? Asking the project maintainer to review and accept your changes.

  1. Go to your forked repository on GitHub (github.com/YOUR-USERNAME/Good-first-Issue)
  2. You should see a yellow banner saying "Compare & pull request" - click it!
  3. Add a title: Add [Your Name] to contributors
  4. Add a description (optional but nice):
    Hi! This is my first contribution to open source.
    I've added my name to the contributors list.
    Thank you for this beginner-friendly project! πŸŽ‰
    
  5. Click "Create pull request"

βœ… Success Check: You should see your PR with a number (e.g., #42)


πŸŽ‰ Congratulations!

You just made your first open source contribution! 🎊

Your Pull Request will be reviewed and merged soon. Once merged, your name will appear in the contributors list on the main repository!

What Happens Next?

  1. A maintainer will review your PR (usually within 24-48 hours)
  2. They might ask for small changes (don't worry, this is normal!)
  3. Once approved, your PR will be merged
  4. Your name will officially appear on this project! 🌟

πŸ‘₯ Contributors

These amazing people have completed their first contribution! 🎯

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

About

A beginer friendly repository that tends to make user learn about the basics of open source contributions

Resources

Code of conduct

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors