Skip to content

OpenSource Compass is a beginner-friendly, community-driven platform that guides students and first-time contributors in open source. It offers Git/GitHub basics, contribution best practices, do’s and don’ts, and a hub for programs like SWOC, GSSoC, GSoC, Hacktoberfest, etc

License

Notifications You must be signed in to change notification settings

pushtikadia/OpenSource-Compass

 
 

Repository files navigation

🌍 OpenSource Compass

✨ Lost in open source? We've got your map! πŸ—ΊοΈ

OpenSource Compass Banner

Open Source GitHub Issues GitHub License


πŸš€ What is OpenSource Compass?

Your ultimate guide to jumping into the open source world! No fancy jargon. No confusing steps. Just real answers for beginners who want to start contributing and making an impact.

Think of us as your friend who knows all the shortcuts! 🀝


πŸ’‘ Our Promise

We believe: Every developer deserves a clear path to contributing.

We deliver: Simple guides, real examples, and friendly community support to get you started.


🎯 What You'll Learn Here

πŸ“– Guides πŸŽ₯ Resources πŸ’¬ Community
Step-by-step tutorials Video lessons Support & help
Do's and Don'ts Articles & tips Mentorship
Real examples Learning paths Making friends

✨ Amazing Features

πŸ”₯ Beginner Friendly Guides - No experience needed!

πŸš€ Quick Start Instructions - Get going in 5 minutes

πŸŽ“ Learn Git & GitHub - From zero to hero

πŸ“š Tons of Resources - Videos, articles, everything

🌟 Program Information - SWOC, GSSoC, GSoC & more

🀝 Community Support - We've got your back!


πŸ’» What We Use

  • HTML5 - Beautiful structure
  • CSS3 - Stunning design
  • JavaScript - Cool features
  • JSON - Smart data handling

πŸ“‚ How It's Organized

OpenSource-Compass/
β”œβ”€β”€ πŸ“„ index.html (Main page)
β”œβ”€β”€ πŸ“ guides/ (Learning materials)
β”œβ”€β”€ πŸ“ programs/ (Open source programs)
β”œβ”€β”€ πŸ“ resources/ (Videos & articles)
β”œβ”€β”€ 🎨 css/ (Beautiful styling)
β”œβ”€β”€ βš™οΈ js/ (Interactive features)
└── πŸ“Š data/ (Program info)

🎬 Getting Started (Super Easy!)

1️⃣ Fork the Repo

Click "Fork" on GitHub. Done! βœ…

2️⃣ Clone It

git clone https://github.com/YOUR-USERNAME/OpenSource-Compass.git
cd OpenSource-Compass

3️⃣ Open & Play

Double-click index.html or use a server. That's it! πŸŽ‰

4️⃣ Time to Contribute

Make changes β†’ Test β†’ Push β†’ Create Pull Request ✨


🀝 How to Help (We Need You!)

πŸ’ͺ Ways to Contribute

✏️ Fix typos and improve writing

🎨 Make it look better and prettier

πŸ“ Add new guides and tutorials

πŸ› Find and fix bugs

πŸ’‘ Share awesome ideas


πŸ“‹ How to Send Your Changes

Step 1: Create your own branch

git checkout -b feature/amazing-idea

Step 2: Make your magic! ✨

Step 3: Test everything in your browser

Step 4: Save your work

git add .
git commit -m "Add something awesome"

Step 5: Push to GitHub

git push origin feature/amazing-idea

Step 6: Create a Pull Request Go to GitHub and click "Create Pull Request". Done! πŸš€


βœ… Do These Things

βœ”οΈ Ask questions - we love helping!

βœ”οΈ Read the existing code first

βœ”οΈ Make small, focused changes

βœ”οΈ Test your work

βœ”οΈ Be nice and respectful


❌ Don't Do These Things

❌ Don't make huge changes all at once

❌ Don't ignore feedback from reviewers

❌ Don't add random files

❌ Don't be mean to people

❌ Don't skip testing


πŸ’ Code of Conduct

Be awesome. Be kind. Be respectful.

We don't accept:

  • 😠 Rudeness or bullying
  • πŸ‘Ž Mean comments
  • 🚫 Discrimination
  • πŸ’¬ Hateful language

Everyone is welcome here! 🌈


🌟 Open Source Programs

Join these cool programs and get recognized! πŸ†

  • SWOC - Student Winter of Code 🎿
  • GSSoC - GirlScript Summer Code πŸ‘©β€πŸ’»
  • GSoC - Google Summer of Code πŸš€
  • Hacktoberfest - October fest! πŸŽƒ

πŸ“š Learn More

Right Here:

  • Getting Started Guide
  • Git & GitHub Tutorial
  • Programs Hub
  • Video Library
  • Tips & Tricks

Out There:


πŸ› Found a Bug?

We want to know! Tell us! πŸ“’

  1. Check if someone already reported it
  2. Click "New Issue" on GitHub
  3. Write what happened
  4. We'll fix it! βœ…

🎁 Cool Ideas to Contribute

  • πŸ“ Add more program guides
  • 🎨 Make the design cooler
  • πŸ“± Fix mobile issues
  • πŸŽ₯ Add video tutorials
  • 🌍 Translate to other languages
  • ⭐ Share your success story

πŸš€ What's Coming Next?

We're planning:

  • πŸ“± Mobile app
  • πŸ‘€ User accounts
  • πŸ’¬ Forums & discussions
  • πŸ… Achievement badges
  • 🌐 Many languages
  • πŸ€– AI helper

πŸ‘₯ Join Us!

Love what we do?

⭐ Give us a star on GitHub!

🍴 Fork and contribute

πŸ’¬ Share feedback

πŸ“£ Tell your friends


πŸ“œ License

MIT License = You can use, modify, and share freely! πŸŽ‰


πŸ™ Special Thanks

Big thanks to everyone contributing! You make this awesome! πŸ’–


❓ Need Help?

πŸ“§ Open an issue on GitHub

πŸ’¬ Join our discussions

πŸ“š Check our guides


πŸš€ Quick Links

Repository | Issues | Pull Requests


❀️ Made with Love for the Open Source Community

Let's make open source awesome for everyone!

⭐ Please star if this helps you! ⭐

About

OpenSource Compass is a beginner-friendly, community-driven platform that guides students and first-time contributors in open source. It offers Git/GitHub basics, contribution best practices, do’s and don’ts, and a hub for programs like SWOC, GSSoC, GSoC, Hacktoberfest, etc

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • HTML 80.0%
  • CSS 11.5%
  • JavaScript 8.5%