Skip to content

Latest commit

 

History

History
118 lines (86 loc) · 3.81 KB

CONTRIBUTING.md

File metadata and controls

118 lines (86 loc) · 3.81 KB
Raw

Contributing to Visual Sort

Thank you for considering contributing to Visual Sort! We welcome contributions from everyone. Here are some guidelines to help you get started.

Please Make sure you Star the repository ⭐

#How to Raise an Issue

  1. Navigate to the Repository:

  2. Open the Issues Tab:

    • Click on the "Issues" tab located at the top of the repository page.

  3. Create a New Issue:

    • Click the "New issue" button.
    • Provide a clear and descriptive title for your issue.
    • In the description, explain the problem or the feature you are suggesting. Be as detailed as possible.
    • Project admin will Assign the appropriate tags: VSoC’24, EASY, MEDIUM, HARD, or 1-POINT, depending on the nature of the issue.

  4. Submit the Issue:

    • Click the "Submit new issue" button.

How To Contribute

  • First Fork the repository

#Clone the Repository

Using the Command Line

  1. Navigate to the Repository:

  2. Clone the Repository:

    • Click on the "Code" button.

    • Copy the URL provided.

    • Open your terminal or command prompt.

    • Run the following command to clone the repository:

      git clone https://github.com/MastanSayyad/Visual-Sort.git

  3. Navigate to the Repository Directory:

    • Change to the repository directory:

      cd Visual-Sort

Using GitHub Desktop

  1. Download and Install GitHub Desktop:

  2. Open GitHub Desktop:

    • Open the GitHub Desktop application.

  3. Clone the Repository:

    • Click on "File" in the menu bar and select "Clone repository..."
    • In the "Clone a Repository" window, select the "URL" tab.
    • Paste the repository URL into the "Repository URL" field: https://github.com/MastanSayyad/Visual-Sort.git
    • Choose the local path where you want to clone the repository.
    • Click "Clone".

#How to Make a Pull Request (PR)

  1. Create a New Branch:

    • In your terminal or command prompt, create a new branch for your changes:

      git checkout -b [branch name]

    • Replace [branch name] with a descriptive name for your branch.

    • Or, in GitHub Desktop:

      • Go to the "Branch" menu and select "New Branch..."
      • Enter a descriptive name for your branch and click "Create Branch".

  2. Make Your Changes:

    • Open the project in your preferred code editor.
    • Make the necessary changes or additions.

  3. Commit Your Changes:

    • Stage your changes:

      git add .

    • Commit your changes with a clear and concise commit message:

      git commit -m "Description of changes"

    • Or, in GitHub Desktop:

      • In the "Changes" tab, write a summary of the changes in the "Summary" field.
      • Click "Commit to [branch name]".

  4. Push Your Changes:

    • Push your changes to your forked repository:

      git push origin [branch name]

    • Replace [branch name] with the name of your branch.

    • Or, in GitHub Desktop:

      • Click "Push origin" in the toolbar.

  5. Create a Pull Request:

    • Navigate to your forked repository on GitHub.
    • Click on the "Compare & pull request" button next to your recently pushed branch.
    • Provide a clear title and description for your pull request.
    • Click the "Create pull request" button.

  6. Wait for Review:

    • Your pull request will be reviewed by the project maintainers. Be prepared to make any requested changes.

Thank you for considering contributing to Visual Sort!!