OpenTitan Onboarding Guide

Requesting a user account

Whether the user account is as a Partner Individual or an Individual Collaborator, new accounts should be requested as below. The first section should be managed by a representative of the partner organisation (or by the individual if an Individual Collaborator). All other sections should be completed by the individual.

Note that in general, partners will have a limited number of available accounts.

Onboarding request (by the partner organisation)

• Check initial account setup Ensure that all individuals have completed the first section below (Initial account setup)

• Request OpenTitan accounts The organisation should contact onboarding@opentitan.org specifying: - The partner organisation which is requesting the accounts, and for each individual: - The email address to which the Google account is linked - Confirming that an appropriate security key is activated on the account. - Which working groups each individual would initially like to join. - If the individual will need to join the OpenTitan GitHub team: - The individual’s GitHub name - Confirm that multifactor authentication (MFA) is set up on the GitHub account.

Initial account setup (before onboarding request)

Before your organisation requests accounts, please complete these steps.

• Create a Google account You should create a Google account (or use an existing Google account if one exists) linked to your existing corporate email address.

• Add a security key to your account You will need to add a security key (please see the list of allowed keys here) to your Google account.

• Assess working group memberships The OpenTitan working groups are organized using Google Groups and hold meetings every other week. Identify any working groups which you would like to join and include in the request below.

• Set up MFA for your GitHub account (if needed) If you will actively be working on OpenTitan, you will need to join the OpenTitan GitHub team.

  • This will grant you 'triage' access to the OpenTitan repository which allows you to assign reviewers to your Pull Requests and add labels to issues.
  • You will need to set up 2FA for your GitHub account in accordance with the security policy.

Finish OpenTitan account setup

Once you have been notified that an OpenTitan account has been set up, please complete these steps.

• Add the OpenTitan team meeting calendar Follow this link to add the team meeting calendar to your OpenTitan calendar.

• Review working group memberships

  • Check your OpenTitan account calendar to see the meeting schedule for any working groups of which you are a member.
  • Any working groups which were not joined on signing up can be joined by contacting onboarding@opentitan.org

• Access the OpenTitan Team Drive

  • This will be where you will find project documentation, beyond what is on this site.

Review important documentation

• Familiarize yourself with the goals and mechanisms of the OpenTitan project

  • Introduction to the OpenTitan Project
  • Contributing to OpenTitan

• Read key policy documents

  • OpenTitan accounts security policy
  • Information Classification policy

Set up additional accounts

• OpenTitan Slack

  • When your OpenTitan account was created you should have been sent a link to join the OpenTitan Slack.
  • Slack is a great place to ask questions, see announcements and connect with other OpenTitan contributors.

• Join OpenTitan GitHub Team

  • If this was requested when onboarding, your GitHub account will be sent an invitation to the lowRISC organization.
  • Please accept the invitation within 7 days or it will expire.

Start working on OpenTitan

• Follow the Getting Started guide Some additional documents you might find particularly useful as you get going:

  • Bazel notes
  • GitHub notes

• Take a look at the Hardware Dashboard

  • The Hardware Dashboard provides an overview of the status of the different blocks that make up the OpenTitan project.
  • It also links to the documentation for each block, as well as the nightly test results.