Skip to content

CONTRIBUTION.md

Latest commit

 

History

History
225 lines (156 loc) · 5.46 KB

CONTRIBUTION.md

File metadata and controls

225 lines (156 loc) · 5.46 KB

🤝 Contributing to Nitra Mitra

Welcome to the Nitra Mitra open-source project!
We’re excited to collaborate with students, developers, designers, and contributors from all backgrounds.

Whether you're fixing bugs, improving UI/UX, adding features, or working with PHP/MySQL — there's a place for you here!

📌 Project Overview

Nitra Mitra is a student-focused platform built to share college-specific content like notes, question papers, blogs, and placement updates.
It needs improvements across frontend, backend, SEO, automation, and UI/UX.

Your contribution can help this platform reach more students and provide real academic value.

🚀 Getting Started

Before starting, make sure you have the following installed:

  • PHP
  • MySQL
  • XAMPP / WAMP / MAMP (or your local server)
  • Git
  • VS Code or any preferred IDE

🧩 How to Get Started

  1. Fork the repository

  2. Clone your forked repo
    git clone https://github.com/<your-username>/repo-name.git

  3. Set local repo cd repo-name

  4. Install dependencies npm install

  5. Add original repo as remote to keep your fork updated git remote add upstream https://github.com/VAIBHAVBABELE/vaibhavbabele.github.io.git

  6. Create a new branch
    git checkout -b feature/your-feature-name

  7. After all update add it git add .

  8. Make changes and commit
    git commit -m "Added: your feature name"

  9. Push to your fork
    git push origin feature/your-feature-name

  10. Open a Pull Request with a clear description (on github account)

  11. for php and mysql use xampp.

🛠️ Contribution Areas (Level-Wise)

We’ve broken down the contributions into 6 major categories — each with Beginner, Intermediate, and Advanced tasks.

1. 🎨 UI/UX Improvements

Beginner

  • Fix spacing, fonts, colors
  • Add alt tags to images
  • Improve visual consistency

Intermediate

  • Make layout fully responsive
  • Upgrade navbar, footer, buttons
  • Add smooth animations

Advanced

  • Redesign components using Figma
  • Plan UX flows and accessibility
  • Implement visual feedback from users

2. 💻 Frontend Development (HTML, CSS, JavaScript)

Beginner

  • Fix content layout and links
  • Add missing sections (About, Contact)
  • Basic CSS improvements

Intermediate

  • Add JS for toggle, search, filters
  • Use Bootstrap for cards, modals
  • Create static content pages

Advanced

  • Theme toggle, dark mode
  • Performance optimization
  • Reusable HTML components

3. 🪲 Bug Fixes and Code Cleanup

Beginner

  • Fix broken images, alignments
  • Clean unused code
  • Improve visual bugs

Intermediate

  • JS error debugging
  • Console warning fixes
  • Validations for forms

Advanced

  • PHP bug fixes
  • Responsive layout issues
  • Database-related debugging

4. 🚀 Features and Enhancements

Beginner

  • Add FAQs, Terms, Privacy
  • Create feedback/upload forms

Intermediate

  • Make blog/news dynamic
  • Add filters, college selectors
  • Basic admin dashboard

Advanced

  • Secure login/signup system
  • Chat & help system
  • Leaderboard, notification alerts

5. 🔧 Backend Development (PHP & MySQL)

Beginner

  • Create forms that store data
  • Basic data submission pages

Intermediate

  • Fetch content from DB
  • Admin CRUD system

Advanced

  • User sessions and roles
  • Block/report system
  • Searchable dynamic content

6. 🔗 Tool Integration & Automation

Intermediate

  • Google Apps Script to sync Sheets
  • Embed videos, calendars

Advanced

  • Email APIs for alerts
  • File upload with validation
  • SEO + schema markup integration

🏷 Labels You’ll See on Issues

Label Description
good first issue Perfect for beginners
frontend HTML, CSS, JavaScript related
backend PHP & database related
bug Something broken or incorrect
enhancement Improvements to existing features
feature Brand new functionality
design UI/UX tasks or visual improvements
documentation Update or create README and docs

✅ After You Contribute

Please update the README.md file if you:

  • Add a new feature
  • Change the setup process
  • Modify major UI/UX or backend functionality

This helps future contributors and users understand your work better.

Include:

  • ✅ Updated instructions
  • 🖼️ Screenshots (if visual changes)
  • 🗃️ Database setup (if backend-related)

💡 Tips for a Smooth Contribution

  • 🔍 Check open issues before starting
  • ✋ Ask to be assigned by commenting: "I want to work on this"
  • 🔗 Keep commits atomic and meaningful
  • 💬 Add code comments and avoid unnecessary files
  • 🧪 Test your feature locally before pushing

🎓 Recognition & Rewards

  • 🙋 All contributors will appear in the Contributors tab
  • 🏆 Active contributors will receive certificates
  • 🚀 Top PRs will be featured on the project website

🔒 Code of Conduct

Be kind, helpful, and inclusive.
This is a learning space for all experience levels. 💙

🙌 Let’s Build Together!

Thank you for contributing to Nitra Mitra.
Every commit counts toward making this project better for students across colleges!

Happy Contributing! 🎉