Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (45 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 3.3 KB
Raw

Contributing to EduSathi

First off, thank you for considering contributing to EduSathi! It's people like you that make EduSathi such a great tool for students everywhere.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please be respectful and welcoming to all contributors.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for EduSathi. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Check existing issues: Before creating a new issue, please check if the issue has already been reported.
  • Use a clear and descriptive title: This helps identify the problem quickly.
  • Provide detailed steps to reproduce the bug: Explain exactly how to trigger the bug.
  • Describe the expected behavior: Tell us what you expected to happen.
  • Describe the actual behavior: Tell us what actually happened.
  • Include environment details: OS, browser, node version, python version, etc.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for EduSathi, including completely new features and minor improvements to existing functionality.

  • Check existing issues: See if the enhancement has already been suggested.
  • Use a clear and descriptive title: Identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Explain why this enhancement would be useful: Describe the problem it solves or the value it adds.

Pull Requests

The process described here has several goals:

  • Maintain EduSathi's quality.
  • Fix problems that are important to users.
  • Engage the community in working toward the best possible EduSathi.
  • Enable a sustainable system for EduSathi's maintainers to review contributions.

Please follow these steps to have your contribution considered by the maintainers:

  1. Fork the repository on GitHub.
  2. Clone your fork locally: git clone https://github.com/YOUR_USERNAME/edusathi.git
  3. Create a branch for your feature or bug fix: git checkout -b feature/your-feature-name or git checkout -b fix/your-bug-fix-name.
  4. Make your changes and commit them with descriptive commit messages.
  5. Test your changes to ensure they work as expected and do not break existing functionality.
  6. Push your branch to your fork: git push origin your-branch-name.
  7. Open a Pull Request against the main branch of the original repository.

Development Setup

Please refer to the README.md for detailed instructions on how to set up the development environment, including backend (FastAPI) and frontend (React/Vite).

Backend Development

  • The backend is written in Python using FastAPI.
  • Ensure you have activated your virtual environment before running the server or installing packages.
  • Follow PEP 8 style guidelines for Python code.

Frontend Development

  • The frontend is built with React, TypeScript, and Tailwind CSS.
  • Ensure your code passes TypeScript compilation and linting.
  • Follow React best practices and component-driven development.

Questions?

If you have any questions, feel free to open an issue or reach out to the maintainers. We are here to help!