Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
122 lines (91 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

122 lines (91 loc) · 2.6 KB
Raw

Contributing to GradGT

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

What to Improve

There are many ways to contribute to GradGT, including:

  • Adding new features
  • Improving existing visualizations
  • Fixing bugs
  • Enhancing UI/UX
  • Improving documentation
  • Optimizing performance

Check out our Issues tab for specific tasks that need attention.

Project Structure

The project is built with Next.js and uses a modern React stack:

  • /src/app/ - Next.js app router pages and layouts
  • /src/components/ - React components
  • /src/lib/ - Utility functions and API handlers
  • /public/ - Static assets
  • /data/ - Course and prerequisite data

Development Environment Setup

Prerequisites

  • Node.js (v18 or higher)
  • npm or yarn
  • Git

We recommend using Visual Studio Code with the following extensions:

  • ESLint
  • Prettier
  • Tailwind CSS IntelliSense

Getting Started

  1. Fork the repository
  2. Clone your fork:
git clone https://github.com/YourUsername/GradGT.git
cd GradGT
  1. Install dependencies:
npm install
# or
yarn install
  1. Start the development server:
npm run dev
# or
yarn dev
  1. Visit http://localhost:3000 to see your changes

Making Changes

  1. Create a new branch for your feature/fix:
git checkout -b feature/your-feature-name
  1. Make your changes
  2. Test your changes thoroughly
  3. Commit your changes with clear, descriptive messages
  4. Push to your fork
  5. Create a pull request

Code Style

  • Follow the existing code style
  • Use TypeScript for type safety
  • Use Tailwind CSS for styling
  • Write clear comments for complex logic
  • Keep components modular and reusable

Before Submitting a Pull Request

  1. Run linting:
npm run lint
  1. Ensure all tests pass:
npm run test
  1. Format your code:
npm run format
  1. Update documentation if needed
  2. Test your changes in both light and dark modes
  3. Verify mobile responsiveness

Creating a Pull Request

  1. Go to the GradGT repository
  2. Click "New Pull Request"
  3. Select your fork and branch
  4. Fill in the PR template:
    • Clear title describing the change
    • Detailed description of changes
    • Reference any related issues
    • Add screenshots if applicable
    • List any breaking changes

Need Help?

Feel free to reach out to the maintainers or open an issue if you need help or have questions. We're here to help!