Introduction To Open Source (Beginner Hub)

Start here

• New to open source? Start with these in order:
  • Read: docs/what-is-open-source.md
  • Read: docs/how-github-works.md
  • Learn: docs/git-basics.md
  • Do a task: practice/add-your-name.md
  • Then open your first PR: docs/how-to-create-pr.md

What is open source?

• Open source is code that is public
• People can read it, learn from it, and improve it
• You can contribute small changes and get them merged

Why contribute?

• Learn real teamwork (Git + GitHub)
• Build a public profile (your GitHub)
• Improve your resume
• Get ready for:
  • GSoC
  • internships
  • developer jobs

Roadmap: zero → first merged PR

1) Learn the basics

• Read the docs pages (links below)
• Learn the words: repo, fork, clone, branch, commit, PR

2) Setup Git (one-time)

• Install Git

• Run once:

  git --version

• Set your name/email (example):

  git config --global user.name "Your Name" git config --global user.email "you@example.com"

3) Make your first contribution

• Pick a practice task:
  • practice/add-your-name.md
  • practice/fix-typo.md
  • practice/simple-task.md
• Follow the step-by-step guide:
  • CONTRIBUTING.md

Docs (learn step-by-step)

• Open source basics:
  • docs/what-is-open-source.md
  • docs/how-github-works.md
• Git + GitHub steps:
  • docs/how-to-fork.md
  • docs/how-to-clone.md
  • docs/how-to-create-branch.md
  • docs/how-to-commit.md
  • docs/how-to-push.md
  • docs/how-to-create-pr.md
• Helpful topics:
  • docs/how-to-fix-merge-conflicts.md
  • docs/git-basics.md
  • docs/github-issues.md
  • docs/project-structure.md

Getting help

• If you’re stuck:
  • Re-read the doc for your step
  • Open an issue and describe:
    • what you tried
    • what you expected
    • what happened

License

• See LICENSE