Getting started with GitHub pull requests and review
Listen now
Description
Brian and Aurooba walk through the process of submitting a pull request in GitHub, reviewing it, and merging it into a repository – discussing best practices and perspectives to take as the reviewer and the reviewee in an ongoing pull request. In this case, the open source project was wphelpers.dev and Brian was adding a fantastic new helper: a searchable guide to the WordPress Icon library (@wordpress/icons), which they also take a look at. A full transcript of the episode is available on the website. Watch the video podcast on YouTube and subscribe to our channel and newsletter to hear about episodes (and more) first! The searchable icon library – https://wphelpers.dev/icons The Post Status slack comment that prompted the creation of wphelpers.dev – https://poststatus.slack.com/archives/C0413TGQZ/p1645727796428859 @wordpress/icons repo – https://github.com/WordPress/gutenberg/blob/3f5da7aa3b3b2f37301a498f401c7623d989bb9d/packages/icons/README.md @wordpress/icons visual reference – https://wordpress.github.io/gutenberg/?path=/docs/icons-icon--library Netlify deploy previews – https://docs.netlify.com/site-deploys/deploy-previews/ Netlify collaborative drawer – https://www.netlify.com/products/deploy-previews/ Brian's viral tweet thread about the searchable icon library – https://www.briancoords.com/building-the-wordpress-icon-library/ Brian's website – https://www.briancoords.com Aurooba's website – https://aurooba.com (00:00) - Introduction (00:13) - A tangent on wearing a uniform everyday (02:05) - Recapping v1 of this episode we had already recorded (02:42) - Getting into the topic: collaborating on GitHub (03:46) - Introducing wphelpers.dev and how it came to be (05:04) - How the searchable icon library guide came to be (06:12) - The portability of Gutenberg packages (07:20) - Walking through the searchable Icon Library (09:23) - How wp-scripts interacts with @wordpress/icons (09:51) - Our favourite uses for the searchable icon library (11:02) - Diving into the pull request (11:41) - Creating work-in-progress PRs (12:56) - Collaborating with the deploy preview feature in Netlify (13:14) - Getting feedback early on in the process (14:16) - The netlify collaboration drawer (15:07) - The ideal opening comment on a PR (16:27) - Requesting a review in GitHub (16:49) - Determing the right time to request a review (17:47) - The features of an official review in GitHub (20:53) - Making new issues from incoming feedback (21:27) - Creating trackable history in GitHub (25:13) - Requesting changes through reviews in GitHub (26:13) - The code view in PRs and its features (27:40) - GitHub reviews allow you to post your comments holistically (30:23) - Automatic deployment with Netlify (31:35) - Using the right tool for the situation (33:21) - Discovering the existing icon library visual reference
More Episodes
Aurooba and Brian dig deeper into the WordPress Interactivity API. This episode mostly focuses on the HTML directives they used in their custom blocks, how they work with block markup, and how the Interactivity API uses them to hydrate data. Along the way they also compare it to other templating...
Published 04/29/24
Published 04/29/24
So begins another project! This time back inside WordPress. Brian and Aurooba discuss the Interactivity API in WordPress. They explore how to use the API, the challenges they faced, and the benefits it provides. They also touch on JavaScript modules and how they are used in the context of the...
Published 04/15/24