Onboarding

Onboarding

Welcome. This walkthrough gets a new member set up and productive. It should take under an hour.

First day

• Accept the invitation to the organisation. If you have not received one, ask your supervisor or an administrator.
• Enable two-factor authentication on your GitHub account. It is required for membership. GitHub's guide to configuring 2FA walks you through it.
• Set your organisation membership visibility. Please keep it private unless you are actively contributing.

Get oriented

• Read the Contributing guide and the Code of Conduct.
• Skim this wiki, starting with the FAQ.
• Confirm you have been added to the team for your project or course. Access is granted through teams, so if a repository you expect to see is missing, that is usually why.

Set up to work

• Install and sign in to git and, if you like, the GitHub CLI.
• Clone the repository you will be working on.
• Read its README.md before making changes, and follow the workflow in the Contributing guide: work on a branch, open a pull request, keep commits clear.

Before you commit anything

Two habits worth forming from the start:

• Never commit personal data or credentials. Student names, numbers, EMPL IDs, marks and submissions never belong in a repository.
• Keep experiments and rough work on your personal account until they are ready to bring into the organisation.

Stuck?

Ask your supervisor or course convener first. For access or permissions, contact a repository administrator, failing which an organisation administrator.