getting-started-with-github-copilot/.github/steps/5-copilot-on-github.md

Step 5: Using GitHub Copilot within a pull request

Congratulations! You are finished with coding for this exercise (and VS Code). Now it's time to merge our work. 🎉 To wrap up, let's learn about two limited-access Copilot features that can speed up our pull requests!

📖 Theory: GitHub Copilot for pull requests

Copilot pull request summaries

Typically, you would review your notes and commit messages then summarize them for your pull request description. This may take some time, especially if commit messages are inconsistent or code is not documented well. Fortunately, Copilot can consider all changes in the pull request and provide the important highlights, and with references too!

Copilot code review

More eyes on our work is always useful so let's ask Copilot to do a first pass before we do a normal peer review process. Copilot is great at catching common mistakes that are fixed by simple adjustments, but please remember to use it responsibly.

Note

These features are only available on paid plans of GitHub Copilot. [docs]

⌨️ Activity: Summarize and review a PR with Copilot

Both Copilot pull request summaries and Copilot code review have limited access, so this activity is mostly optional. If you don't have access, skip the optional steps of this activity.

1. In a web browser, open another tab and navigate to your exercise repository.

2. You might notice a notification banner suggesting to create a new pull request. Click that or use the Pull Requests tab at the top to create a new pull request. Please use the following details:

   • base: main
   • compare: accelerate-with-copilot
   • title: Improve student activity registration system

3. (Optional) In the PR description toolbar click the Copilot icon and Summary action. After a moment, Copilot will add a description based on your changes. 📝

   

4. (Optional) In the right side information panel at the top, locate the Reviewers section and click the Request button next to a Copilot icon. Wait a moment for Copilot to add a review comment to your pull request!

   

   💡 Tip: Notice a log entry that Copilot was requested for a review.

5. At the bottom, press the Merge pull request button. Nice work! You are all done! 🎉

6. Wait a moment for Mona to check your work, provide feedback, and post a final review of this exercise!