Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (68 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

94 lines (68 loc) · 3.02 KB

🤝 Contributing to Alum-Connect

Hello and welcome! 👋 Firstly, thank you for considering contributing to Alum-Connect — your time and effort mean a lot to us! This project has been selected as one of the top 200 for GSSOC’25 Phase 2 🎉 and is being mentored by Shirshendu R Tripathi. We aim to build a seamless platform that connects alumni and current students to foster mentorship, collaboration, and growth.

🧾 Table of Contents

  • [Getting Started]
  • [How to Contribute]
  • [Code of Conduct]
  • [Coding Guidelines]
  • [Raising Issues]
  • [Making Pull Requests]
  • [Community and Support]
  • [Acknowledgements]

🚀 Getting Started

  1. Fork the Repository
  2. Clone your forked repo git clone https://github.com/stuticoder123/Alum-Connect.git

📜 Code of Conduct

We follow the [Contributor Covenant Code of Conduct].

  • Be respectful, inclusive, and supportive to everyone.
  • Harassment, hate speech, or inappropriate behavior will not be tolerated.
  • Communicate professionally and thoughtfully.

📏 Coding Guidelines

  • Use meaningful variable, class, and function names.
  • Maintain consistent code formatting and indentation.
  • Include comments and documentation wherever necessary.
  • Ensure cross-browser compatibility and responsive design for frontend.
  • Ensure secure, modular, and clean architecture for backend.

Frontend

  • Use semantic HTML, responsive CSS, and accessibility best practices.
  • Keep components reusable and organized.
  • Avoid unnecessary inline styles.

Backend

  • Follow RESTful API design principles.
  • Sanitize inputs and handle all exceptions properly.
  • Structure code into proper folders/modules for scalability.

🔖 Raising Issues

  • Search the Issues tab before creating a new one.

  • When opening a new issue:

    • Add a short and clear title.
    • Describe the bug or feature request in detail.
    • Attach screenshots or logs if applicable.
    • Add relevant labels like bug, enhancement, documentation, or GSSOC.

  • Be respectful and patient while discussing issues.

    🧑‍🤝‍🧑 Community and Support

  • Join the official GSSOC Discord to connect with fellow contributors and mentors.

  • For project-related discussions, use:

    • GitHub Discussions or Issues tab.
    • Tag the maintainer or admin if urgent.

  • Always be kind, respectful, and welcoming.

  • Encourage collaboration and learning through positive engagement.

❤️ Acknowledgements

  • Special thanks to GSSOC 2025 for selecting this project under Phase 2 as the 170th Ranked Project.
  • Heartfelt gratitude to our project admin and mentor Shirshendu R Tripathi for guidance and support.
  • And most importantly — thank YOU, contributor, for helping build Alum-Connect into something amazing!

Let's learn, build, and grow together 🌱✨

✅ Making Pull Requests

  • Make sure your fork is up-to-date with the base repository: 
    git fetch upstream
git merge upstream/main