-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgithub_teams.qmd
82 lines (37 loc) · 4.7 KB
/
github_teams.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
---
title: "GitHub Teams"
---
## What are GitHub teams
You can use teams to manage access for people in an organization and for sending notifications (you can @team as you will do with @user in issues, commit messages, and more). Teams are a great way to manage access to repositories. You can add specific people to different teams and then you can use those teams to provide similar access to repositories. If you are familiar with Google Groups and how they can be used to provide access to folders in Google Drive, this is the same concept.
Teams are very convenient when a set of collaborators work on the same project and therefore need the same access to different repositories within your organization. You can simply add the team to a specific repository and all the team members will be added to the repositories instead of having to add each user individually.
## Create a team
In the navigation bar at the top of your organization page, click on the _Teams_ tab. Normally this is the page you use to see and manage the existing teams of your organization. Since we do not have teams yet, this page provides a short overview of what teams can be used for. Click on the _New Team_ green button at the bottom to start creating your first team.
Proved the name and a short description of your team. We recommend to let the other options to their default settings.
{fig-align="center" width=70%}
Your team has been created, but as of now you are the only member. Let's invite some collaborators by clicking on the _Add a member_ button on the top right.
{fig-align="center" width=90%}
On this new window, you can search for GitHub users by their username. If you do not know their username you can search by their full names. Note that if there are no pictures associated with the profile you found or are not sure it is the right person, we recommend **not** adding this person at this time and reaching out asking for their username (which is unique). When you are sure you found the right persons you can click on _Invite_.
{fig-align="center" width=60%}
Your collaborators will receive an invitation to join the team. They will have to accept the invitation before they can use the benefits (access to repositories, ...) associated with the team. Once your collaborators have accepted your team should look like below.
{fig-align="center" width=90%}
OK, let's create a second team! In this example, we will create a Research Facilitators team with two members.
{fig-align="center" width=90%}
Once your GitHub organization has teams, you will the number of existing teams next to the _Teams_ tab.
## Leveraging teams
Let's create a new repository and use our newly created teams to add several collaborators at once.
{fig-align="center" width=90%}
Under your newly created organization, create a new repository with the following settings:
{fig-align="center" width=80%}
Once the repository is created, click on the _Settings_ tab (top right in the grey bar)
{fig-align="center" width=80%}
On the left panel, click on _Collaborators and teams_ and then click on the green button _Add teams_
{fig-align="center" width=90%}
Start typing the name of the team you would like to add. Suggestions of teams should come up as you type. Select the relevant team by clicking on the suggestion.
{fig-align="center" width=60%}
For close collaborators, we recommend using the _Maitain_ level of access that provides a good blend of people being able to do most of the actions they will need to do while not being allowed to conduct destructive actions on accident (like deleting the entire repository). For collaborators you are less familiar with, including their familiarity with GitHub, you might want to start with the _Write_ access.
{fig-align="center" width=70%}
Once the team added, your settings should look as follow:
{fig-align="center" width=90%}
The good news is now if you add a collaborator to a specific team, this person will automatically gain access to all the repositories that team has access to! This will streamline the on- and off- boarding process of your team members.