Skip to content

Latest commit

 

History

History
90 lines (55 loc) · 2.08 KB

contribution.md

File metadata and controls

90 lines (55 loc) · 2.08 KB

Contributing to Sorting Visualizer

Welcome! 🎉 We're excited that you're interested in contributing to the Sorting Visualizer project. This guide will help you get started with setting up the project and submitting a high-quality pull request.

🛠 Tech Stack

  • ReactJS v18
  • Material-UI v4

🚀 Setting Up the Project

  1. Clone the Repository

    git clone https://github.com/Mr-G-D/Sorting-Visualizer.git
cd sorting-visualizer

  2. Install Dependencies
    Ensure you have Node.js (v14 or above) and npm/yarn installed.
    npm install
    or
    yarn install

  3. Start the Development Server
    npm start
    or
    yarn start

📌 Contribution Guidelines

Please follow the steps below to contribute:

Step 1: ⭐ Star the Repo

If you like this project, please star it. It helps others find it too!

Step 2: 🍴 Fork the Repo

Click the Fork button on the top-right of the repo to create a copy under your GitHub account.

Step 3: 🌿 Create a Branch

Create a new branch for your fix/feature using a descriptive name that includes the issue ID (if applicable):

git checkout -b feat/#issue-id-brief-description

Example:

git checkout -b feat/#12-add-bubble-sort

Step 4: 💡 Make Your Changes

Follow the coding standards of the project:

  • Use clear and descriptive variable names
  • Maintain consistent indentation and formatting
  • Comment complex logic if necessary

Step 5: ✅ Test Before You Commit

Make sure your changes work as expected:

  • UI behaves correctly
  • No console errors
  • No linting errors

Step 6: 📄 Create a Detailed Pull Request

Once you're ready, push your changes and open a Pull Request:

  • Provide a clear title
  • Include a description of what you changed and why
  • Link the related issue(s), if any
  • Add before/after screenshots for UI changes

Example PR title:

feat: Add bubble sort animation (#12)

🙏 Thank You

Thanks for contributing! 💙
If you have any questions, feel free to open an issue or reach out to the maintainers.