Skip to content

Latest commit

 

History

History
120 lines (87 loc) · 3.16 KB

CONTRIBUTION.md

File metadata and controls

120 lines (87 loc) · 3.16 KB

Contributing to EduHaven

Thank you for your interest in contributing to EduHaven as part of GirlScript Summer of Code (GSSoC) 2025!
We’re excited to have you here and appreciate your time and effort to improve this project.

🚀 Code of Conduct

We expect all contributors to follow our Code of Conduct.
Be respectful, helpful, and open to learning. This is a beginner-friendly project.

📋 Contribution Guidelines

1️⃣ Getting Started

  • Fork this repository.
  • Clone your forked repository locally: 
    
git clone https://github.com/your-username/EduHaven.git
cd EduHaven

    

    • 

  • Set up the project by running the command:
 npm install
followed by:
npm run dev
in both directories.


    • 

  • Create .env files in both folders using the provided .env.example files.
    • 





2️⃣ Working on Issues


    

  • Pick an issue from the Issues section.
    • 

  • Look for beginner-friendly labels:

      

    • good first issue
      • 

    • beginner friendly
      • 

    • documentation
      • 

    

    • 

  • Comment on the issue to get assigned before starting work (mandatory for GSSoC tracking).
    • 





3️⃣ Creating a Feature or Fix Branch


    

  • Always pull the latest main branch before starting:

      git checkout main
  git pull origin main

    

    

    • 

  • Create a new branch for your feature or fix:

    git checkout -b feature/your-feature-name
    

    • 





4️⃣ Writing Your Code


✅ Follow existing code style and folder structure.

✅ Write clear and meaningful commit messages:


git commit -m "Fix: correct navbar overflow on mobile"


✅ Add screenshots in your Pull Request if your change affects the UI.




5️⃣ Submitting a Pull Request


    

  • Push your branch to your fork:

    git push origin feature/your-feature-name
    

    • 

  • Open a Pull Request to the dev branch of this repository (not main).
    • 

  • Fill out the PR description properly and link any related Issue.
    • 





6️⃣ Code Review & Merging


    

  • One or more maintainers will review your PR.
    • 

  • You may be asked to make changes—this is part of the process.
    • 

  • Once approved, your PR will be merged.
    • 





🏷 Labels You’ll See






Label
Meaning






good first issue
Beginner-friendly issues




bug
Something isn’t working as expected




enhancement
New feature or improvement




UI
Design or frontend-related change




needs discussion
Requires further clarification








🙌 Tips for a Great Contribution


    

  • Keep PRs small and focused—one fix or feature per PR.
    • 

  • Add clear before/after screenshots for any UI changes.
    • 

  • Be polite, patient, and open to feedback.
    • 





❓ Need Help?


    

  • Ask in the GSSoC Discord or discussion forums.
    • 

  • Open an Issue in this repo if you're stuck.
    • 





Thank you for being part of EduHaven 🙌

Let’s build something awesome together!