Skip to content

Latest commit

 

History

History
42 lines (25 loc) · 3.16 KB

vi-github-pull-request.md

File metadata and controls

42 lines (25 loc) · 3.16 KB

GitHub Pull Request Tutorial

A pull request is a proposal to merge modifications from one branch into another. It allows collaborators to review and discuss the proposed changes before integrating them into the main code base. About pull requests | GitHub Docs contains more information on their proper usage.

1. Open a Pull Request

Now, go to your forked repository on GitHub by visiting https://github.com/<YourUsername>/<YourUsername>.github.io. GitHub will detect that you recently pushed a new branch.

  1. Click the "Compare & pull request" button as highlighted in the screenshot below. If it doesn't appear, go to the 'Pull requests' tab and click on the "New pull request" button.

    Compare & Pull Button

  2. Follow the pull request template carefully and complete the necessary details in the description.

    Pull Request Template

    There are a few things to watch out before clicking on the "Create pull request" button. Make sure you:

    • add title and issue number(when applicaple) in the title field
    • fill the checkboxes
    • write description
    • add RawGitHack Preview link
    • verify you satisfied the requirements you are creating this pull request for

  3. Submit the pull request

  4. Once redirected to the newly created pull request, complete the tasks listed under "After Creating the Pull Request" by ticking each checkbox as you finish them.

  5. Post the link to your pull request in our Discord channel along with any required links.

    A member of our team will review your changes and notify you on Discord. Reviewers often provide feedback, so be prepared to address their suggestions or corrections. If you receive feedback, make the necessary changes in your branch by navigating to the file in your forked repository or by clicking on the pull request's "Files changed" tab, selecting "...", and then "Edit file." Leave a comment on the pull request once you're finished, and don't forget to notify us on Discord. Any updates you make to your branch will automatically reflect in the pull request.

  6. Wait for your pull request to be merged. Once merged, proceed to delete your branch.

NOTE: Only delete your branch after your pull request has been successfully merged!

2. Delete the Branch

After your pull request has been approved and merged, you might want to delete the associated branch to keep your local and remote (<YourUsername>.github.io on GitHub) repository clean and free of defunct branches.

  • To delete the branch in your remote repository, click the "Delete branch" button in your pull request (see the picture below).

    Delete Merged Branch

  • To delete the branch from your local repository, use the command git branch -d <YourLocalBranchName>. Ensure you are not currently on the branch you want to delete. For more information on deleting a branch locally, go here.