Skip to content

Forking the captions repository and creating a pull request

Drew Neil edited this page Jul 6, 2015 · 6 revisions

The best way to submit corrections on Peer to Peer captions is to create a pull request (PR).

[Before proofreading] Fork (or update) the captions repository and check out the proofreading branch

  • go to fromPeerToPeer/captions and click the fork button
  • (or if you already have a fork of that repository, sync it to bring it up to date)
  • clone your fork of the repository to your workstation
  • check out the branch called proofreading-{guest-name}-captions (replacing {guest-name} with the name of the guest featured in the video that you're proofreading)

Make your corrections on that branch. (Read our article on Proofreading captions as a technical reviewer to learn about the kind of corrections we're looking for.)

[After proofreading] Create a pull request with your corrections

When you've finished making your corrections:

  • push your changes to the proofreading-{guest-name}-captions branch of your personal fork
  • go to the GitHub page for your repository
  • click the "Branch" button and switch to the proofreading-{guest-name}-captions branch (Screenshot hint)
  • click the "Pull request" button (Screenshot hint)
  • ensure that your pull request targets the proofreading-{guest-name}-captions branch of the fromPeerToPeer/captions base fork
  • Give the PR a title including the episode number (e.g. #4) and the timestamps for the portion that you proofread (format: h:mm-h:mm) (Screenshot hint)
  • Click the "Create pull request" button