Using a Github Template

Article Info
Publish Date
Last Updated
(f874a72)
Tags
Howto

Overview

This guide explains how to create a repository based on a template on Github Enterprise.

You might need to do this for some workshop tasks, or assessment activities. Templates provide structure to your repository, and sometimes provide a starting point for getting started with a project.

Before you start

Before you try to use a template repository, ensure:

  • You have access to the Github Enterprise server (github.falmouth.ac.uk)

Important: Do not confuse github.com and the Github Enterprise server. You should use the Github Enterprise Server for your student work.

Using a Template Repository

  1. Navigate to the template you are using
  2. Click the, “use as template” button at on the respository page: A screenshot of the action bar from Github, showing the use this template button next to the other options
  3. Ensure that the template selected is correct: a cropped screenshot of the create new repostory page, showing the template selected from the dropdown. Include all branches is not checked.
  4. Enter a suitable repoistory name: A cropped screenshot showing the owner and repository name fields on the new repository page. the owner has been set to student work and the name has been set to comp101-as1-123456
    1. The repository must have the Games-Academy-Student-Work-$year as the owner (ie, for 23-24 academic year, the owner should be: Games-Academy-Student-work-23-24)
    2. The repsoitory name must use the required format: $modulecode-as1-$studentnum
  5. Select the visiablity for the repoistory A cropped screenshot showing the three possible visablity options (public, internal, and private) for a repository, private is checked.
    1. For most assignment repositories, private makes sense - with the correct owner, then staff can see the repo, but other students cannot
  6. Click the ‘Create Repository’ button A cropped screenshot showing the create repository button

See Also

Graduation Cap Book Open book GitHub Info chevron-right Sticky Note chevron-left Puzzle Piece Lightbulb Video Exclamation Triangle Globe