Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (81 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

116 lines (81 loc) · 3 KB
Raw

Contributing to StudyMatePlus

Thank you for considering contributing to StudyMatePlus, an open-source resource hub for students built with ❤️ during GirlScript Summer of Code 2026 (GSSoC'26).

Whether you're a beginner or an experienced developer, your contributions are valued and appreciated.

Project Structure

StudyMatePlus/

├── client/ # Frontend (React.js / Next.js)

├── server/ # Backend (Node.js / Express)

├── docs/ # Diagrams, UI mockups

├── .github/ # Issue & PR templates

├── README.md # Project overview

├── CONTRIBUTING.md # You're here!

├── LICENSE # MIT License

└── .env.example # Sample environment variables

How to Contribute

1. Fork this Repository

Click the Fork button in the top-right corner to create your own copy.

2. Clone Your Fork

git clone https://github.com/your-username/StudyMatePlus.git
cd StudyMatePlus

3. Create a Branch

git checkout -b your-feature-name

4. Make Changes

Work on your assigned issue or feature. Follow coding guidelines, and test your code before pushing.

5. Push Changes

git add .
git commit -m "✨ Added: Your short meaningful commit message"
git push origin your-feature-name

6. Create a Pull Request

Go to your forked repo on GitHub Click Compare & pull request Give a clear PR title and description Link the issue (e.g., Fixes #12) Add relevant screenshots if UI-related

Issue Types & Labels

  • Label Description
  • good first issue Simple tasks perfect for beginners
  • easy Minor fixes or UI tweaks
  • medium Features or enhancements requiring logic
  • hard Complex modules like auth, database logic
  • documentation README, guides, or any documentation tasks

Suggestions for Contributions

  • Fix bugs
  • Add features (chat system, filters, feedback forms, etc.)
  • Improve UI/UX design
  • Add test cases
  • Write or enhance documentation

Beginner-Friendly Guide

  • First time contributing to open source? Don’t worry:
  • Look for issues labeled good first issue
  • Ask questions in the issue comments
  • Mention what you want to work on
  • We’ll guide you through it!

Code Guidelines

  • Write clean, readable, and maintainable code
  • Use consistent formatting and indentation
  • Use meaningful variable & function names
  • Follow the existing codebase structure
  • Use comments to explain complex logic
  • Test thoroughly before creating a PR

Testing Instructions

  • Frontend: Run npm start in /client and test changes locally
  • Backend: Use tools like Postman to test API routes
  • Check for responsive design & no console errors

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Code of Conduct

Please read and follow our Code of Conduct to ensure respectful and inclusive collaboration.

Need Help?

Join our GSSoC 2025 Discord or contact the Project Admin:

Lovely Mahour | Project Admin LinkedIn lovelymahour1405@gmail.com Happy Contributing & Good Luck in GSSoC 2025! 💖