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

Amangp/OpenSource-Compass

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌍 OpenSource Compass

Navigate Your Open Source Journey with Confidence

OpenSource Compass – SWOC'26 Banner

Open Source GitHub Issues GitHub License

❄️ Script Winter of Code (SWOC) 2026

Script Winter of Code (SWOC) is a winter-long open-source program that mentors students through meaningful, real-world contributions.


📌 About OpenSource Compass

Your ultimate beginner-friendly guide to open source.
No jargon. No confusion. Just clear steps to help you start contributing with confidence.

Think of this as your friendly roadmap into open source 🌱


🎯 Project Vision & Objectives

  • Simplify Git & GitHub for beginners
  • Explain real-world open-source workflows
  • Share curated learning resources
  • Prepare contributors for SWOC, GSSoC, GSoC & Hacktoberfest
  • Foster an inclusive & welcoming community

📖 What You’ll Learn

📖 Guides 🎥 Resources 💬 Community
Step-by-step tutorials Video lessons Peer support
Do’s & Don’ts Articles & tips Mentorship
Real examples Learning paths Collaboration

✨ Key Features

  • 🔰 Beginner-friendly guides
  • 🚀 Quick start in under 5 minutes
  • 🎓 Git & GitHub from basics to confidence
  • 📚 Curated videos & articles
  • 🌟 Program info (SWOC, GSSoC, GSoC, etc.)
  • 🤝 Supportive community

🛠 Tech Stack

  • HTML5 – Clean & semantic structure
  • CSS3 – Modern, responsive styling
  • JavaScript – Interactive functionality
  • JSON – Lightweight data handling

📂 Project Structure

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)

👥 Team — SWOC’26

🛠 Project Admin

Name Role GitHub LinkedIn
Sayee Gosavi Project Admin @sayeeg-11 https://linkedin.com/in/sayee-gosavi11

Responsible for project direction, reviews, and overall quality.


🧑‍🏫 Mentors

Name Role GitHub LinkedIn
Sameera Jape Mentor @sameera731 https://linkedin.com/in/sameera-jape
Satyam Pandey Mentor @Satyam12x https://linkedin.com/in/satyam-pandey-301061272
Gopichand Mentor @Gooichand https://linkedin.com/in/gopichand-d-269709287

Mentors guide contributors, review pull requests, and provide feedback throughout SWOC’26.


🤝 Contribution Guidelines (SWOC’26)

How to Contribute

  1. Browse the Issues section
  2. Comment on the issue you want to work on
  3. Wait for assignment
  4. Create a new branch
  5. Make your changes
  6. Open a Pull Request

📌 Important Rules

  • Do not create a PR without issue assignment
  • Keep changes focused and meaningful
  • Follow mentor feedback and repository guidelines

📄 refer #23 – Important Contributing Guidelines for OpenSource Compass


🚀 Getting Started

Follow these steps to set up the project locally and start contributing.

1️⃣ Fork the Repository

Click the Fork button on GitHub to create a copy under your account.

2️⃣ Clone the Repository

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

3️⃣ Run the Project

Open index.html directly in your browser or use a local development server.

4️⃣ Start Contributing

Make changes → Test → Push → Create Pull Request


How You Can Contribute ?

✏️ Fix typos and improve writing

🎨 Make it look better and prettier

📝 Add new guides and tutorials

🐛 Find and fix bugs

💡 Share awesome ideas


📋 Submitting Your Changes

Step 1: Create a New Branch

git checkout -b feature/your-feature-name

Step 2: Make Your Changes

Implement your updates following project guidelines.

Step 3: Test Locally

Ensure everything works correctly before committing.

Step 4: Commit Your Work

git add .
git commit -m "Brief description of your changes"

Step 5: Push to GitHub

git push origin feature/your-feature-name

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

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 54.1%
  • CSS 23.0%
  • JavaScript 22.9%