CONTRIBUTING.md

Contributing to OpenLearn NITJ Website

Thank you for your interest in contributing to the OpenLearn NITJ website! This document provides guidelines and instructions for contributing.

Getting Started

1. Fork the repository on GitHub
2. Clone your fork locally
3. Install dependencies with npm install
4. Create a feature branch for your contribution
5. Make your changes
6. Test your changes locally with npm run dev
7. Push to your branch
8. Open a Pull Request

Development Guidelines

Code Style

• Follow the existing code style in the project
• Use TypeScript for all new code
• Use functional components with hooks for React components
• Write clear, descriptive comments for complex logic

Commit Messages

Please use clear, descriptive commit messages that explain what your changes do. For example:

• "Add event details to RSVP section"
• "Fix mobile navigation menu alignment"
• "Update Firebase security rules for better protection"

Pull Requests

• Each PR should address a single concern or feature
• Include a description of the changes you've made
• Reference any relevant issues
• Make sure all tests pass before submitting

Project Structure

• src/components/ - React components
  • layout/ - General layout components (Header, Footer)
  • sections/ - Main content sections
  • ui/ - Reusable UI components
  • rsvp/ - RSVP form-related components
• src/firebase/ - Firebase configuration and utilities

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub. Please include:

• A clear, descriptive title
• Steps to reproduce the issue
• Expected and actual behavior
• Screenshots if applicable
• Any relevant code snippets

Seeking Help

If you need help with the project, you can:

• Open an issue with your question
• Join our Discord server and ask in the appropriate channel

Thank you for contributing to the OpenLearn NITJ community!