Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
250 lines (202 loc) · 6.6 KB

CONTRIBUTING.md

File metadata and controls

250 lines (202 loc) · 6.6 KB
Raw

Contributing to Collaborative Code Editor - GSSoC 2025

Welcome to the Collaborative Code Editor project! We're excited to have you as part of GSSoC 2025. This document will guide you through the contribution process and help you get started.

📑 Table of Contents

🚀 Getting Started

Prerequisites

  • Basic knowledge of JavaScript/React
  • Familiarity with Git and GitHub
  • Enthusiasm to learn and contribute!

Quick Start

  1. Fork this repository
  2. Clone your fork locally
  3. Create a new branch for your work
  4. Make your changes
  5. Test your changes
  6. Commit and push to your fork
  7. Create a Pull Request

📋 GSSoC 2025 Guidelines

Project Structure

codeeditor/
├── backend/          # Node.js + Socket.IO backend
├── frontend/         # React + Vite frontend
├── .github/          # GitHub workflows and templates
└── docs/            # Documentation

Available Issues

  • Look for issues labeled with:
    • gssoc2025 - GSSoC 2025 specific issues
    • good first issue - Beginner friendly
    • help wanted - Need assistance
    • bug - Bug fixes
    • enhancement - New features

Contribution Areas

Frontend (React + Vite)

  • UI/UX improvements
  • New features
  • Bug fixes
  • Performance optimizations
  • Accessibility improvements

Backend (Node.js + Socket.IO)

  • API enhancements
  • Real-time features
  • Security improvements
  • Performance optimizations
  • Testing

Documentation

  • README updates
  • API documentation
  • User guides
  • Code comments

🛠️ Development Setup

Backend Setup

cd backend
npm install
npm run dev

Frontend Setup

cd frontend/vite-project
npm install
npm run dev

Environment Variables

Create .env files as needed (see .env.example files)

📝 Code Standards

JavaScript/React

  • Use ES6+ features
  • Follow React best practices
  • Use meaningful variable names
  • Add comments for complex logic
  • Follow the existing code style

Git Commit Messages

Use conventional commit format:

type(scope): description

feat(frontend): add dark mode toggle
fix(backend): resolve socket connection issue
docs(readme): update installation instructions

Pull Request Guidelines

  • Title: Clear and descriptive
  • Description: Explain what and why, not how
  • Screenshots: Include for UI changes
  • Testing: Describe how you tested
  • Related Issues: Link to relevant issues

🧪 Testing

Frontend Testing

cd frontend/vite-project
npm run test

Backend Testing

cd backend
npm test

Manual Testing

  • Test on different browsers
  • Test responsive design
  • Test real-time features
  • Test edge cases

📚 Learning Resources

React & Vite

GSSoC Resources

🤝 Communication

Getting Help

  • GitHub Issues: For bugs and feature requests
  • GitHub Discussions: For questions and discussions
  • Discord: Join the GSSoC community

Code Reviews

  • Be respectful and constructive
  • Focus on the code, not the person
  • Ask questions if something is unclear
  • Suggest improvements politely

🏆 GSSoC 2025 Evaluation

Your contributions will be evaluated based on:

  • Code Quality: Clean, readable, and maintainable code
  • Documentation: Clear documentation and comments
  • Testing: Proper testing and edge case handling
  • Communication: Professional and helpful communication
  • Innovation: Creative solutions and improvements

🎯 Milestone Goals

Phase 1: Onboarding

  • Set up development environment
  • Understand project structure
  • Make first small contribution
  • Familiarize with codebase

Phase 2: Active Development

  • Work on assigned issues
  • Collaborate with mentors
  • Learn advanced concepts
  • Help other participants

Phase 3: Project Completion

  • Complete major features
  • Write comprehensive tests
  • Update documentation
  • Prepare final submission

🚨 Important Notes

Code of Conduct

  • Follow our Code of Conduct
  • Be respectful and inclusive
  • Report any violations immediately

Intellectual Property

  • All contributions become part of the project
  • Ensure you have rights to contribute
  • Don't include proprietary code

Security

  • Don't commit sensitive information
  • Report security vulnerabilities privately
  • Follow security best practices

📞 Contact Information

Project Maintainers:

🎉 Welcome to GSSoC 2025!

We're excited to see your contributions and help you grow as a developer. Remember:

  • Ask questions - There are no stupid questions!
  • Be patient - Learning takes time
  • Have fun - Open source should be enjoyable
  • Help others - We're all learning together

Good luck with your contributions! 🚀✨

GSSoC 2025 Edition