Social Winter of Code (SWOC) is a winter-long open-source program that mentors students through meaningful, real-world contributions.
- 📖 About the Project
- 🎯 Vision & Objectives
- ✨ Key Features & Learning Paths
- 🛠 Tech Stack
- 📂 Project Structure
- 🚀 Getting Started
- 👥 Team & Mentors
- 📜 License
Note
Think of this as your friendly roadmap into open source 🌱
Your ultimate beginner-friendly guide to open source.
No jargon. No confusion. Just clear steps to help you start contributing with confidence.
- 🏁 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
| Feature | Description | Benefit |
|---|---|---|
| 🔰 Beginner Guides | Step-by-step Git & GitHub tutorials | Build confidence from scratch |
| 🚀 Quick Start | Setup guide in under 5 minutes | Start contributing immediately |
| 🎓 Program Info | Roadmap for GSoC, SWOC, GSSoC | Find your next big opportunity |
| 🤝 Supportive Community | Peer support and mentor reviews | Never get stuck alone |
Click to view Project File Structure
OPENSOURCE-COMPASS/
├── .github/
│ ├── ISSUE_TEMPLATE/
│ ├── workflows/
│ └── PULL_REQUEST_TEMPLATE.md
├── backend/
│ ├── config/
│ ├── controllers/
│ ├── middleware/
│ ├── models/
│ ├── routes/
│ └── server.js
├── frontend/
│ ├── assets/templates/
│ ├── css/
│ ├── data/
│ ├── js/
│ ├── library/
│ ├── pages/
│ └── node_modules/
├── public/
├── 404.html
├── index.html
└── README.md
| Name | Role | GitHub | |
|---|---|---|---|
| Sayee Gosavi | Project Admin | @sayeeg-11 |
Responsible for project direction, reviews, and overall quality.
| Name | Role | GitHub | |
|---|---|---|---|
| Sameera Jape | Mentor | @sameera731 | |
| Satyam Pandey | Mentor | @Satyam12x | |
| Gopichand | Mentor | @Gooichand |
Mentors guide contributors, review pull requests, and provide feedback throughout SWOC’26.
Thanks to these amazing people who have contributed to OpenSource Compass ✨
Important
Please read our detailed CONTRIBUTING.md guide before you start! It covers everything from setup to pull request standards.
- Browse the Issues section
- Comment on the issue you want to work on
- Wait for assignment
- Create a new branch
- Make your changes
- Open a Pull Request
Important
Do not create a PR without issue assignment. Unsolicited PRs may be closed. Always follow mentor feedback and repository guidelines.
📄 Refer to issue #23 – Important Contributing Guidelines for OpenSource Compass
Follow these steps to set up the project locally and start contributing.
Click the Fork button on GitHub to create a copy under your account.
git clone https://github.com/YOUR-USERNAME/OpenSource-Compass.git
cd OpenSource-CompassWarning
Do NOT open index.html directly (file://).
This will break features like the Program Hub and Contributor Wall. You must use a local development server.
Recommended Method:
- Install the Live Server extension in VS Code.
- Right-click
index.htmland select "Open with Live Server". - The site will open at
http://127.0.0.1:5500.
Make changes → Test → Push → Create Pull Request
| Category | Description |
|---|---|
| ✏️ Fix Typos | Improve writing and fix documentation errors |
| 🎨 Design | Make it look better and prettier |
| 📝 Content | Add new guides and tutorials |
| 🐛 Bugs | Find and fix bugs in the code |
| 💡 Ideas | Share awesome ideas for new features |
git checkout -b feature/your-feature-nameImplement your updates following project guidelines.
Ensure everything works correctly before committing.
git add .
git commit -m "Brief description of your changes"git push origin feature/your-feature-nameGo to GitHub and click "Create Pull Request". Done! 🚀
| ✅ Do These Things | ❌ Don't Do These Things |
|---|---|
| ✔️ Ask questions - we love helping! | ❌ Don't make huge changes all at once |
| ✔️ Read the existing code first | ❌ Don't ignore feedback from reviewers |
| ✔️ Make small, focused changes | ❌ Don't add random files |
| ✔️ Test your work | ❌ Don't be mean to people |
| ✔️ Be nice and respectful | ❌ Don't skip testing |
Be awesome. Be kind. Be respectful.
We don't accept:
- 😠 Rudeness or bullying
- 👎 Mean comments
- 🚫 Discrimination
- 💬 Hateful language
Tip
Everyone is welcome here! 🌈
Join these cool programs and get recognized! 🏆
- SWOC - Social Winter of Code 🎿
- GSSoC - GirlScript Summer Code 👩💻
- GSoC - Google Summer of Code 🚀
- Hacktoberfest - October fest! 🎃
- Getting Started Guide
- Git & GitHub Tutorial
- Programs Hub
- Video Library
- Tips & Tricks
We want to know! Tell us! 📢
- Check if someone already reported it
- Click "New Issue" on GitHub
- Write what happened
- We'll fix it! ✅
- 📝 Add more program guides
- 🎨 Make the design cooler
- 📱 Fix mobile issues
- 🎥 Add video tutorials
- 🌍 Translate to other languages
- ⭐ Share your success story
We're planning:
- 📱 Mobile app
- 👤 User accounts
- 💬 Forums & discussions
- 🏅 Achievement badges
- 🌐 Many languages
- 🤖 AI helper
- ⭐ Give us a star on GitHub!
- 🍴 Fork and contribute
- 💬 Share feedback
- 📣 Tell your friends
MIT License = You can use, modify, and share freely! 🎉
Big thanks to everyone contributing! You make this awesome! 💖
- 📧 Open an issue on GitHub
- 💬 Join our discussions
- 📚 Check our guides
Repository | Issues | Pull Requests
Join our growing community! Connect with us on Discord for:
- 💬 Real-time discussions and support
- 🚀 Project updates and announcements
- 💡 Feature suggestions and feedback
- 🤝 Collaboration opportunities
