Trying to understand the feedback branch/PR in assignments

Hello,

When I created my first assignment in GitHub Classroom, I saw that, in addition to the main branch of the original repository, student repositories had a feedback branch. I also saw the automatically-created pull request. It wasn’t clear to me from the instructions how these fit together. Does work that students do in any branch go into the PR or just work that they do in the main branch?

Thank you.

Ellen

Hey @ellenspertus, when you create an assignment, there is an option to Enable feedback pull requests as show in the snip below. Only if this option is enabled, your student repositories will have a feedback branch.
The students will still have to push their code to the master branch, but the changes that they do will be visible in the Feedback PR. The trainer can then review student’s code and provide proper feedback using PR comments.

Thank you. I did enable feedback pull requests, which is how I got the feedback branch and pull request I mentioned.

What I meant to ask was how the student’s commits fit with it. I am familiar with ordinary GitHub workflows. Is the automatically created feedback pull request the same as if the student created the feedback branch and opened a draft PR from the main/master branch, or is it something different?

I also want to know this, because I don’t see what the new branch has to offer other than a way for a careless student to commit somewhere I won’t see it in my normal workflow.

Can we get a video showing the intended usage?

When you enable the Feedback Pull Requests, two things are created: a feedback branch and then the Feedback pull request from the main branch (main, master, etc.) to the feedback branch. See the screenshot below:

feedback

Students then push commits to the main branch, and doing so automatically updates the PR with the additional commits. This might be confusing at first because the PR direction is reversed from normal, where you’d be merging into the main branch.

edit: this information is basically the same as what was said above (thanks @TripathyM!), but I’m trying to emphasize the direction of the PR to help resolve some confusion about how it works. If a student pushes to another branch it won’t update the PR.

© 2017 GitHub, Inc.
with by
GitHub Education