Submit a Pull Request (Easy Mode)

Summary

Simplified pull request flow

Prerequisites

If you are new to git, see Git (Private)

Quickstart

  1. Install the github client > https://desktop.github.com/
  2. Add a repository
  • if you are adding a repository that you already cloned, choose add the existing repository in the UI > https://www.loom.com/share/d4f4bd0c7cda499f948aa45a41b72513
  • if you are cloning a new repository, select clone repository
  • NOTE: the Dendron team workspace is a composite of multiple repositories. you want to add each one individually

Submit a pull request

Video Example: https://www.loom.com/share/429f9cdfa7eb4b728b50e46983ea3e93

  1. Make changes in the repository
  2. Switch to the github app
  3. Create a new branch
  • select take your changes to new branch
  1. Commit the changes
  2. Publish changes
  3. Create a pull request
  4. Add reviewers to your pull request
  5. IMPORTANT: While your pull request is in review, don't forget to switch back to the main branch to continue working (otherwise, none of your changes will be changed)
  6. If you get requests to make changes, switch branches by following Making changes to your pull request

Making changes to your pull request

  1. If you get updates on your pull request, switch back to your branch to make any necessary changes
    • if you were working on something in the main branch, run a workspace sync to save the changes
  2. Make changes and push to your branch
    • TIP: there's no need to create another pull request at this point

Merging changes from another branch

See https://youtu.be/UTEHbTO5bnA

Verify

To make sure you're setup, submit a pull request to ext.github.repo.private (Private) with a new note [[user.{username}.hello]] and add @kevin (Private) as a PR reviewer

Checklist

  • create a new branch
  • commit changes to new branch
  • publish branch
  • submit pull request
  • add reviewers to your pull request
  • switch back to the main branch

Backlinks