Add missing documentation on how to quickly checkout a PR

[shmonks]

Dependency

• Information missing about how to checkout PRs in GitHub

Overview

We need to make it easy to:

• Record any missing documentation about how to checkout PRs in GitHub
• Keep those records in one place
• Create new issues based on those records

This issue is the place to record missing documentation and start creating related new issues.

Details

• We are striving to write documentation that helps developers create and review PRs. See Resource 1.01.
• This issue tracks the documentation that needs to be added for quickly checking out PRs in GitHub. If you've noticed missing documentation about other Git and/or Django processes,

see the following issues instead

• Add missing documentation to the PR review guide #419
• Add missing documentation on how to combine migrations in Django #421
• Add missing documentation on how to add an alias in GitHub #423
• Adding missing documentation on how to resolve migration conflicts #424
• Add missing documentation on how to apply changes from one file to another in GitHub #425

Action Items

• For each piece of missing information, copy and paste the following template into a new comment below.

### Overview
We need to add [REPLACE WITH WHAT NEEDS ADDING], so that developers can [REPLACE WITH BENEFIT]

### Action Items
- [ ] [REPLACE WITH ACTION ITEMS]

### Resources/Instructions/Tags 

- 1.01 Example of another team's PR review guide [Website team's PR review guide](https://github.com/hackforla/website/wiki/How-to-review-pull-requests)
- 1.0x [REPLACE WITH LINKS TO ANY EXTERNAL DOCS THAT MIGHT BE USEFUL (WITH INSTRUCTIONS, IF NEEDED)]
- 1.0x [REPLACE WITH ANY RELEVANT TAGS e.g., git, django, etc.]

### Documentation Addition Notes
#### What's missing?
[REPLACE WITH DESCRIPTION OF WHAT'S MISSING FROM THE DOCUMENTATION]
   
#### Where should it go?
[REPLACE WITH URL OR INDICATE NEW PAGE AND PARENT PAGE]

####  When would this information have been useful?
[REPLACE WITH LINK TO THE PR/ISSUE/SITUATION THAT PROMPTED THE NEED FOR THIS CHANGE/ADDITION]
   
#### Which roles will benefit most from this information?
[REPLACE WITH ROLES]

• Fill out as many of the template's fields as possible.
• Copy and paste a link to your comment in Section 2: List of comments/issues about missing documentation on how to checkout a PR below, using the next available number
• Copy the content of your comment
• Create a new issue, pasting the content of your comment into the new issue
• Add the following labels to the new issue
  • feature: docs: PD team documentation
  • size: 0.25pt
  • s: PD team
  • ready for dev lead
  • choose a complexity label that fits
  • choose the role label that fits
• When this new issue has been created, add a link to it in Section 2: List of comments/issues about missing documentation on how to checkout a PR below. Make sure the link to your new issue appears beneath the link to your comment, so we can ensure that all comments get made into issues
• Hide the original comment (you can mark it 'Resolved')

Resources/Instructions

• 1.01 Example of another team's PR review guide Website team's PR review guide

Section 2: List of comments/issues about missing documentation on how to checkout a PR

• 2.01 Missing Documentation on how to quickly checkout a PR #440

[shmonks]

Overview

We need to add documentation so that developers can checkout PRs quickly and effectively.

Action Items

• Add content in the What's missing? section below to a new numbered item and linked page here: https://hackforla.github.io/peopledepot/contributing/howto/, editing or revising if necessary

Resources/Instructions/Tags

1.01 Example of another team's PR review guide Website team's PR review guide
1.02 git

Documentation Addition Notes

What's missing?

• 1.01 Here's how to checkout a PR to local branch pr/xxx:

1. Add this git alias to your global git config:

[alias]
    pr = !sh -c \"git fetch upstream pull/${1}/head:pr/${1} && git switch pr/${1}\"

2. Then, to checkout a PR to local branch pr/xxx (e.g., checking out PR Create SocMajor table #383 to a local branch called pr/383), run this replacing '383' with the relevant number:

git pr 383

3. Note that:

• This might only work in GitHub

• The alias assumes the PRs are in the upstream remote

• 1.02 Here's a way to checkout a PR to local branch prt/xxx which tracks the remote branch from which the PR was originally created:

1. Add this git alias to your global git config:

[alias]
    prt = "!f() { \
      set -x; \
      git fetch --force upstream pull/${1}/head:prt/${1}; \
      git switch prt/${1}; \
      { set +x; } 2>&-; \
      commit_hash=$(git rev-parse HEAD); \
      remote_branch=$(git branch -r --contains $commit_hash | head -n 1); \
      set -x; \
      git branch -u $remote_branch prt/${1}; \
      { set +x; } 2>&-; \
    }; f"

3. Then, to checkout a PR to local branch prt/xxx (e.g., checking out PR Create SocMajor table #383 to a local branch called prt/383), run this replacing '383' with the relevant number:

git prt 383

4. To see tracking info, run:

git status -sb

5. Note that:

• The alias assumes the PRs are in the upstream remote, and that the remote containing the original working branch is set
• This will reset the prt/xxx branch if it already exists

Where should it go?

[REPLACE WITH URL OR INDICATE NEW PAGE AND PARENT PAGE]

When would this information have been useful?

• Fang thought about adding this documentation while reviewing Create SocMajor table #383, though it's useful for all PR reviews

Which roles will benefit most from this information?

• Backend/Dev