Missing Documentation on how to quickly checkout a PR

[vanessaavviles]

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 in which the PR was originally created:

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

[alias]
    prt = "!f() { \
      git fetch upstream pull/${1}/head; \
      commit_hash=$(git rev-parse FETCH_HEAD); \
      remote_branch=$(git branch -r --contains $commit_hash | head -n 1); \
      git switch -C prt/${1} $commit_hash; \
      git branch -u $remote_branch prt/${1}; \
    }; f"

2. 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

3. To see tracking info, run:

git status -sb

4. 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?

When would this information have been useful?

• Fang thought about adding this documentation when reviewing Create SocMajor table #383, though its useful for all PR review.

Which roles will benefit most from this information?

Backend/ Dev