CONTRIBUTING.md

Contributing to Eduroots

Thank you for your interest in contributing to Eduroots! This document provides guidelines and instructions for contributing to our project.

How to Contribute

1. Fork the Repository

   • Click the "Fork" button on the top right of the GitHub page
   • Clone your fork locally: git clone https://github.com/your-username/Eduroots.git

2. Create a Branch

   • Create a new branch for your feature or fix: git checkout -b feature/your-feature-name
   • Use clear and descriptive names for your branches

3. Development

   • Follow our coding standards
   • Write clear, maintainable code
   • Add comments where necessary
   • Test your changes thoroughly

4. Commit Your Changes

   • Write clear commit messages following our conventions
   • Use the present tense ("Add feature" not "Added feature")
   • Reference issues and pull requests in your commits

5. Push and Create a Pull Request

   • Push your branch to your fork: git push origin feature/your-feature-name
   • Create a pull request from your fork to our main repository
   • Provide a clear description of your changes

Code Standards

• Use TypeScript for all new code
• Follow the existing code style and formatting
• Use meaningful variable and function names
• Write documentation for new features
• Include tests for new functionality

Pull Request Process

1. Update the README.md with details of changes if needed
2. Update the documentation if you're changing functionality
3. The PR will be merged once you have the sign-off of at least one maintainer
4. Address any feedback or requested changes before merging

Getting Help

If you need help or have questions:

• Open an issue
• Join our community discussions
• Contact the maintainers

Thank you for contributing to Eduroots! Your help is valuable in improving this educational platform.