When working in a larger organization, a well-built pull request is important. Many organizations use pull requests for code review, so your team members can review the changes you made and provide feedback.
- GitHub Help: Using pull requests
If you need a refresher on pull requests, you can check out a GitHub Guide which will cover the top to bottom flow: clone the code, make a change, and issue a pull request.
Teams are a great way to mention groups of people but don’t hesitate to mention specific people too. A great shorthand is to mention specific users if you’re intending them to specifically give a look at the changes you’re making. Then mention a team even if the specific mentions are also a part of the team. That way, you will get the review you’re looking for.
In stage 2, Allison showed you how to create a simple pull request 0:00 on one of your own repositories. 0:04 When you're working in a larger organization, 0:06 a well built pull request is even more important. 0:08 Many organizations use pull requests for code review. 0:11 When you make a change to the code, 0:14 you invite your team to review the changes you've made and provide feedback. 0:16 Let me walk you through what that experience is like. 0:20 First, we need to create a small pull request, this time, in the web browser. 0:23 Let's open up our organization repository that we created and 0:29 make a small edit to the readme. 0:33 On this page, click the README file in the file tree. 0:35 Now, in the top right you should see a pencil. 0:40 Click this to edit the file in your browser. 0:43 Now you should see GitHub's browser editor. 0:46 Let's add a small message under the heading that can be anything. 0:49 Okay. 0:55 Now that we're done, at the bottom of the page, we have a small space to 0:57 add our commit message just like we did from the command line earlier. 1:01 We'll say adds a small message to the README. 1:04 There. 1:10 Below that, we have two options. 1:11 We can commit directly to the master branch, 1:14 which is the branch that we're on right now, or we can let 1:16 GitHub automatically create a new branch for us and start a pull request. 1:19 Let's choose that option. 1:23 Now we have to name our branch. 1:26 Let's name our branch updated-readme, and then click propose file change. 1:28 Behind the scenes, GitHub will create a new branch called, Updated README, and 1:36 make this commit to that branch, and 1:40 then automatically bring us to this new poll request page. 1:42 Now, let's open this pull request. 1:46 But first, what makes a good pull request? 1:49 When you're working by yourself, like in stage 2, 1:52 you're just trying to help yourself remember why you're making the change. 1:55 Now as part of a larger team, it's important to be clear 1:59 about what you're changing, and why you're making that change. 2:02 So let's fill that in first. 2:05 For the title, let's keep this action oriented title, 2:08 like GitHub already filled in for us. 2:11 Next, let's add a comment describing the change and why I'm making it. 2:14 Here's something I already wrote. 2:18 One big benefit of using organizations is the ability to use timensions. 2:21 What's a timension you might ask? 2:26 Here, let me show you. 2:28 In the last video, we created the developer's team. 2:30 In the K Daigel Inc organization. 2:33 Let's pretend that the team has dozens of developers on it 2:35 all across the organization, and you want to create an issue and 2:38 suggest that you all start using Ruby on Rails for new projects. 2:42 And you'd like a simple way to make sure that 2:45 every developer in your organization sees that issue. 2:48 If you mention the K Daigle Inc developer's team, 2:51 every member of that team will get a notification for the issue. 2:55 This is called a team mention. 2:59 Every public team that you create within your organization 3:01 will be mentionable in pull requests, issues, and commit messages. 3:04 It's an easy way to include other people in what you're working on. 3:08 In our pull request, let's CC the developer's team. 3:12 We'll do that by using at kdaigle-inc. 3:16 And you'll see the auto complete shows up with the developer's team name. 3:19 This is very similar to how we at mentioned me in stage 2, 3:23 except this time we're at mentioning a whole team of people. 3:27 Click Create Pull Request at the bottom of the screen. 3:31 And there we go. 3:34 Everyone on the developers' team in your organization will get a notification about 3:35 this very well written pull request. 3:40
You need to sign up for Treehouse in order to download course files.Sign up