Getting started with GitHub pull requests and review
05/15/23 • 36 min
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
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
Previous Episode
Explore one of the coolest new features of WordPress 6.2
Aurooba and Brian explore the new WP_HTML_Tag_Processor that landed in WordPress 6.2, and how handy it would be in scenarios where they've had to use regular expressions to modify HTML in their WordPress projects. They then walk through a function using the new processor to inline and safely modify SVGs, ways they could improve the function and take advantage of the processor's capabilities more, and discuss other ways the processor could enhance complicated filtering of rendered output in WordPress.
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 code from this episode – https://github.com/viewSourcePodcast/viewSource-blocks/tree/episode/html-tag-processor
- Aurooba's post with a walkthrough of the code – https://aurooba.com/inline-svgs-in-your-wordpress-code-with-this-helper-function/
- The Dev Note – https://github.com/WordPress/gutenberg/issues/44410#issuecomment-1420787816
- Brian's website – https://www.briancoords.com
- Aurooba's website – https://aurooba.com
- PHP Inline SVG helper function from Ian – https://gist.github.com/ian-svoboda-prom/b7a436d5397e007b7d8d5427465ff161
- Gist to get the file contents of an SVG – https://gist.github.com/rugor/1decc15655891825d15a7024a06d898b
- WP SVG Helper functions – https://gist.github.com/kingkool68/6d72977fe8c82eeb9a85295ac3623cde
- How to Modify HTML in a PHP WordPress Plugin Using The New Tag Processor API – https://adamadam.blog/2023/02/16/how-to-modify-html-in-a-php-wordpress-plugin-using-the-new-tag-processor-api/
Next Episode
Passing Props and Toggling an Element in React.js
Aurooba and Brian complete their accordion in React.js as part of their series on building an accordion block. They discuss how components are loaded into the Dom, binding a value to the className attribute, and thoughts on prop drilling. The episode ends with a preview of the rest of Season One and thoughts on viewSource Season Two.
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!
Code from this episode - https://github.com/viewSourcePodcast/viewSource-blocks/tree/episode/accordion-content-on-page
- Brian's website – https://www.briancoords.com
- Aurooba's website – https://aurooba.com
00:00 Introduction
03:16 Previous code recap
06:54 Adding a key for looping elements
07:54 Components are not HTML elements
09:50 className
13:02 Doing expressions inside attributes
15:03 Adding CSS to our component
16:53 Prop drilling
19:10 useContext vs Prop Drilling
22:27 Attempting to remove a component
27:08 Next Steps for viewSource and Season 2
- (00:00) - E17 - React & Dom & Prop-Drilling
- (03:16) - Previous code recap
- (06:54) - Adding a key for looping elements
- (07:54) - Components are not HTML elements
- (09:50) - className
- (13:02) - Doing expressions inside attributes
- (15:03) - Adding CSS to our component
- (16:53) - Prop drilling
- (19:10) - useContext vs Prop Drilling
- (22:27) - Attempting to remove a component
- (27:08) - Next Steps for viewSource and Season 2
If you like this episode you’ll love
Episode Comments
Generate a badge
Get a badge for your website that links back to this episode
<a href="https://goodpods.com/podcasts/viewsource-254249/getting-started-with-github-pull-requests-and-review-30132919"> <img src="https://storage.googleapis.com/goodpods-images-bucket/badges/generic-badge-1.svg" alt="listen to getting started with github pull requests and review on goodpods" style="width: 225px" /> </a>
Copy