Manage classrooms

You can create and manage a classroom for each course that you teach using GitHub Classroom.

Who can use this feature?

Organization owners who are admins for a classroom can manage the classroom for an organization. For more information on classroom admins, see "Manage classrooms."

In this article

About classrooms

A classroom in GitHub Classroom is where teachers and students interact during a course. Teachers can create a student roster for the classroom, then create, assign, review, and grade assignments within the classroom.

About management of classrooms

GitHub Classroom uses organization accounts on GitHub to manage permissions, administration, and security for each classroom that you create. Each organization can have multiple classrooms.

After you create a classroom, GitHub Classroom will prompt you to invite teaching assistants (TAs) and admins to the classroom. Each classroom can have one or more admins. Admins can be teachers, TAs, or any other course administrator who you'd like to have control over your classrooms on GitHub Classroom.

Invite TAs and admins to your classroom by inviting the personal accounts on GitHub to your organization as organization owners and sharing the URL for your classroom. Organization owners can administer any classroom for the organization. For more information, see Roles in an organization and Inviting users to join your organization.

When you're done using a classroom, you can archive the classroom and refer to the classroom, roster, and assignments later, or you can delete the classroom if you no longer need the classroom.

You can reuse existing assignments in any other classroom you have admin access to, including classrooms in a different organization. For more information, see "Reuse an assignment."

You can also view your classrooms and assignments directly from the GitHub command line interface with the GitHub Classroom extension. For more information, see Using GitHub Classroom with GitHub CLI.

About classroom rosters

Each classroom has a roster. A roster is a list of identifiers for the students who participate in your course.

When you first share the URL for an assignment with a student, the student must sign into GitHub with a personal account to link the personal account to an identifier for the classroom. After the student links a personal account, you can see the associated personal account in the roster. You can also see when the student accepts or submits an assignment.

Prerequisites

You must have an organization account on GitHub to manage classrooms on GitHub Classroom. For more information, see Types of GitHub accounts and Creating a new organization from scratch.

You must authorize the OAuth app for GitHub Classroom for your organization to manage classrooms for your organization account. For more information, see Authorizing OAuth apps.

Creating a classroom

  1. Sign into GitHub Classroom.
  2. Click New classroom on the right side of the page.
  3. In the list of organizations, click the organization you'd like to use for your classroom. Optionally, you can create a new organization. For more information, see "Creating a new organization from scratch."
  4. Under "Classroom name", type the name for your classroom.
  5. Click Create classroom.

After you create a classroom, you can begin creating assignments for students. For more information, see Use the Git and GitHub starter assignment, Create an individual assignment, Create a group assignment, or Reuse an assignment.

Creating a roster for your classroom

You can create a roster of the students who participate in your course.

If your course already has a roster, you can update the students on the roster or delete the roster. For more information, see Adding a student to the roster for your classroom or Deleting a roster for a classroom.

  1. Sign into GitHub Classroom.

  2. In the list of classrooms, click the classroom you want to view.

  3. Under the classroom name, click Students.

    Screenshot of the tabs in a classroom. The "Students" tab is outlined in dark orange.

  4. To connect GitHub Classroom to your LMS and import a roster, your LMS administrator will first need to register your LMS instance and then you will need to connect your LMS course to your classroom. Once connected, you can click the Import from... button to import a roster from your LMS course. For more information, see Connect a learning management system course to a classroom.

    Note

    Google Classroom does not use the LTI protocol, so does not need to be connected to GitHub Classroom before importing the roster. For more information, see "Connect a learning management system course to a classroom."

  5. Provide the student identifiers for your roster.

    • To import a roster by uploading a file containing student identifiers, click Upload a CSV or text file.
    • To create a roster manually, type your student identifiers in the text field.

  6. Click Create roster.

Adding students to the roster for your classroom

Your classroom must have an existing roster to add students to the roster. For more information about creating a roster, see Creating a roster for your classroom.

  1. Sign into GitHub Classroom.

  2. In the list of classrooms, click the classroom you want to view.

  3. Under the classroom name, click Students.

    Screenshot of the tabs in a classroom. The "Students" tab is outlined in dark orange.

  4. To the right of "Classroom roster", click Update students. If you have already linked your classroom to an LMS course, then you will see a Sync from... button instead.

  5. Follow the instructions to add students to the roster.

    • To import students from an LMS, your LMS administrator will first need to register your LMS instance and then you will need to connect your LMS course to your classroom. Once connected, you can click the Sync from... button. For more information, see Connect a learning management system course to a classroom.

      Note

      Google Classroom does not use the LTI protocol, so does not need to be connected to GitHub Classroom before importing the roster. For more information, see "Connect a learning management system course to a classroom."

    • To manually add students, under "Manually add students", click Upload a CSV or text file or type the identifiers for the students, then click Add roster entries.

Renaming a classroom

  1. Sign into GitHub Classroom.

  2. In the list of classrooms, click the classroom you want to view.

  3. Under the classroom name, click Settings.

    Screenshot of the tabs in a classroom. The "Settings" tab is outlined in dark orange.

  4. Under "Classroom name", type a new name for the classroom.

  5. Click Rename classroom.

Archiving or unarchiving a classroom

You can archive a classroom that you no longer use on GitHub Classroom. When you archive a classroom, you can't create new assignments or edit existing assignments for the classroom. Students can't accept invitations to assignments in archived classrooms.

  1. Sign into GitHub Classroom.

  2. To the right of a classroom's name, select the dropdown menu, then click Archive.

    Screenshot of a tile for a classroom. A dropdown menu labeled with a kebab icon is expanded and the "Archive" option is outlined in dark orange.

  3. To view an archived classroom, use the dropdown menu next to the search bar to change the view to "Archived" or "All".

  4. To unarchive a classroom, to the right of a classroom's name, select the drop-down menu, then click Unarchive.

    Screenshot of a tile for a classroom. A dropdown menu labeled with a kebab icon is expanded and the "Unarchive" option is outlined in dark orange.

Deleting a roster for a classroom

  1. Sign into GitHub Classroom.

  2. In the list of classrooms, click the classroom you want to view.

  3. Under the classroom name, click Students.

    Screenshot of the tabs in a classroom. The "Students" tab is outlined in dark orange.

  4. Below the list of students, under "Delete this roster", click Delete roster.

  5. Read the warnings, then click Delete roster.

Deleting a classroom

  1. Sign into GitHub Classroom.

  2. In the list of classrooms, click the classroom you want to view.

  3. Under the classroom name, click Settings.

    Screenshot of the tabs in a classroom. The "Settings" tab is outlined in dark orange.

  4. To the right of "Delete this classroom", click Delete classroom.

  5. Read the warnings.

  6. To verify that you're deleting the correct classroom, type the name of the classroom you want to delete.

  7. Click Delete classroom.

Further reading