Skip to content

Commit a7305d9

Browse files
Use GitHub organizations
This allows all team members to play any role: maintainer or contributor.
1 parent c447631 commit a7305d9

File tree

1 file changed

+36
-39
lines changed

1 file changed

+36
-39
lines changed

activity.md

Lines changed: 36 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,72 @@
11
# GitHub Workflow Activity
22

3+
## 1. Form teams
34

4-
## Form teams
5+
Form a of 2 or 3 person team. It's better to work with someone who is using the same operating system as you.
56

6-
Form a 3-person team. If you can't form a team of 3, form a team of 2.
7+
Each team member will sometimes be a maintainer and sometimes a contributor. Rotate roles as necessary to ensure everyone in your team gets a chance to experience each role.
78

8-
Assign the following roles to the members of your team. If you are in a team
9-
of 2, assign contributor-1 and maintainer to the same person.
109

11-
Roles:
10+
## 2. Overview
1211

13-
- Maintainer: Creates and maintains a GitHub project.
14-
- Contributor-1: Contributes to the GitHub project created by the maintainer.
15-
- Contributor-2: Contributes to the GitHub project created by the maintainer.
16-
17-
Switch roles occasionally. Maintainer doesn't have as much to do as the
18-
contributors. If you do switch roles, physically switch computers. In other
19-
words, the computers should be associated with the roles. This might mean that
20-
the owner of the computer may have to enter his/her password for GitHub
21-
occasionally.
12+
In this activity your team will play out several scenarios following steps
13+
described in _Workflow Reference_ (at the end of this document).
2214

2315

24-
## Overview
16+
## 3. Create an organization on GitHub
2517

26-
In this activity your team will play out several scenarios following steps
27-
described in _GitHub Workflow Reference_ (the other document you were given).
18+
- Name it what you like.
19+
- Set the default permissions so that all organization members can create projects and write to any project in the organization.
20+
- Add all team members to the organization.
2821

2922

30-
## Setup the project
23+
## 4. Create official upstream repository in organization
3124

32-
- Help your maintainer to create a new project on GitHub named `favorites`.
25+
- Name it `ourfavorites`
26+
- Give it a default README.md file.
3327

3428

35-
## Contributor-1 setup
29+
## 5. Contributor-1 setup
3630

37-
- Help Contributor-1 to follow _Setup: (1-4)_ to prepare his/her local and remote repositories.
31+
- Select a team member to be Contributor-1
32+
- Help Contributor-1 to follow _Setup: (1-4)_ in the _Workflow Reference_ to prepare his/her local and remote repositories.
3833

3934

40-
## First contribution
35+
## 6. First contribution
4136

42-
- Help contributor-1 to follow _Starting your contribution: (5-13)_ to add a
43-
new file `favorite-foods.txt` that contains a couple of contributor-1's
37+
- Help Contributor-1 to follow _Starting your contribution: (5-13)_ to add a
38+
new file `favorite-foods.txt` that contains a couple of Contributor-1's
4439
favorite foods.
45-
- Help the maintainer to accept contributor-1's pull-request on GitHub.
46-
- Help contributor-1 to follow _Update your master (27-28)_ and
40+
- Select someone to play Maintainer (not Contributor-1).
41+
- Help the Maintainer to accept Contributor-1's pull-request on GitHub.
42+
- Help Contributor-1 to follow _Update your master (27-28)_ and
4743
_Delete unneeded branches (29-31)_ to clean up.
4844

49-
Congratulations, your team has made its first contribution! Celebrate.
45+
Congratulations, your team has made its first contribution! Celebrate. :clap: :clap:
5046

5147

52-
## Contributor-2 setup and second contribution
48+
## 7. Contributor-2 setup and second contribution
5349

5450
- Help Contributor-2 to follow _Setup: (1-4)_ to prepare his/her local and remote repositories.
5551
- Repeat the steps above to have contributor-2 contribute a new file
5652
`favorite-movies.txt` with a couple of his/her favorite movies.
5753
- Make sure that the maintainer has accepted contributor-2's pull-request and contributor-2 has updated their master and cleaned up.
5854

59-
Celebrate again.
55+
Celebrate again. :clap: :clap:
6056

57+
If you have 3 team members, repeat this scenario adding a file `favorite-animals.txt`.
6158

62-
## First synchronization
59+
## 8. First synchronization
6360

64-
- Contributor-1's repositories are out of synch. Help contributor-1 follow
61+
- Contributor-1's repositories are out of synch. Help Contributor-1 follow
6562
_Keep your repositories up-to-date (18-23)_ to update his/her repositories.
6663

67-
Celebrate. But keep it small. Don't worry, there will be bigger celebrations later.
64+
Celebrate. But keep it small. :clap: Don't worry, there will be bigger celebrations later.
6865

6966

70-
## Contribute conflicting changes
67+
## 9. Contribute conflicting changes
7168

72-
- Have contributor-1 and contributor-2 independently follow the contribution
69+
- Have Contributor-1 and Contributor-2 independently follow the contribution
7370
workflow to add another favorite food to the end of `favorite-foods.txt`.
7471
- Maintainer, accept one of the pull-requests. Try to accept the other. You
7572
won't be able to because changes in the pull-request conflict with the other
@@ -81,10 +78,10 @@ Celebrate. But keep it small. Don't worry, there will be bigger celebrations lat
8178
should be acceptable. Accept the pull-request.
8279
- Have contributors clean up.
8380

84-
Celebrate enthusiastically. That was challenging.
81+
Celebrate enthusiastically. :clap: :clap: :clap: That was challenging.
8582

8683

87-
## Multi-round contribution
84+
## 10. Multi-round contribution
8885

8986
- Have contributor-1 add another food, and contributor-2 another movie.
9087
- Have the maintainer ask for a modification through the pull-request
@@ -98,7 +95,7 @@ communicate about a proposed change. Also notice how the pull-request updates
9895
automatically as new changes are pushed to the same branch.
9996

10097

101-
## Squash
98+
## 11. Squash
10299

103100
- Repeat the multi-round contribution until both contributors have made multiple
104101
commits.
@@ -110,10 +107,10 @@ automatically as new changes are pushed to the same branch.
110107
a single commit.
111108
- Contributors, don't forget to clean up.
112109

113-
This is another moment for an enthusiastic celebration. Well done!
110+
This is another moment for an enthusiastic celebration. :clap: :clap: :clap: :clap: :clap: Well done!
114111

115112

116-
## Copyright and Licensing
113+
## 12. Copyright and Licensing
117114

118115
Copyright 2016 Darci Burdge and Stoney Jackson SOME RIGHTS RESERVED
119116

0 commit comments

Comments
 (0)