Skip to content

Commit 2969577

Browse files
committed
Update Git_workflow_exercises.md
OK? Ready for exercises?
1 parent ccf9568 commit 2969577

File tree

1 file changed

+33
-25
lines changed

1 file changed

+33
-25
lines changed

Diff for: docs/guides/Git_workflow_exercises.md

+33-25
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### GitHub workflows
22

3-
To get setup as a PhUSE CS contributor, see [Contributor_setup.md](https://github.com/phuse-org/phuse-scripts/blob/master/docs/guides/Contributor_Setup.md)
3+
To get setup as a PhUSE CS collaborator, see [Contributor_setup.md](https://github.com/phuse-org/phuse-scripts/blob/master/docs/guides/Contributor_Setup.md)
44

55
### Objective
66

@@ -10,42 +10,37 @@ Script GitHub workflow exercises for CSS 2016.
1010

1111
[GitHub article on Repository Permission Levels](http://help.github.com/articles/repository-permission-levels-for-an-organization/)
1212

13-
1. phuse-or/phuse-scripts Maintainers: can change master code
14-
2. GitHub Contributors: can create "pull request" from their own branch, for the Maintainers to review
13+
1. Write-Access Collaborators (int): can create/modify "master" files
14+
2. Read-Access Collaborators (ext): can send "pull requests" from their own "forks", for the Write-Access team to assess
1515

16-
Relevant roles for phuse-org/phuse-scripts?
17-
1. Admin (manage repository settings, NOT relevant for workshop)
18-
2. Maintainer (write access)
19-
3. Contributors (no write access)? [our repo teams](https://github.com/phuse-org/phuse-scripts/settings/collaboration)
16+
#### Setup for the phuse-org/phuse-scripts repository
2017

21-
#### phuse-or/phuse-scripts Setup
22-
23-
* Master branch is always "production ready"
24-
* Therefore relatively few "Maintainers", who
25-
* have "write access", and can therefore
26-
* review "pull requests" and commit changes to master branch
18+
* Master branch is always "ready to deploy"
19+
* Therefore relatively few "Write-Access" members, who can
20+
* create/modify files directly, and
21+
* review "pull requests", merge them into the "master"
2722
* Any GitHub member can
2823
* "fork" the phuse-scripts repository
29-
* develop new scripts or enhance any element
30-
* create a "pull request", a proposal to incorporate your modifications into the phuse-scripts repository
24+
* create/modify files in their "fork"
25+
* send a "pull request" back to the origin repo (phuse-scripts)
3126

32-
#### GitHub Exercises PSch: Are we creating some 'sandbox for this? What files to we use for examples?
27+
#### GitHub Exercises
3328

34-
* Simple steps: Contributor suggests a change to an UNmodified file on the master branch
35-
1. Contributor:
29+
* Simple scenario: Collaborator suggests a change to an UNmodified file on "master"
30+
1. EXT. Collaborator:
3631
* ... forks the phuse-scripts repository
3732
* ... [or re-SYNC existing, out-of-sync fork]
3833
* ... creates/modifies file in your new fork
3934
* ... creates "pull request" in the fork
4035
* this redirects you to the source repo (note path in page header)
4136
* request pull _from_ your fork, _to_ the original repo
42-
* ... demo & track locations
43-
2. Maintainers:
44-
* ... receives GitHub notification of "pull request" [CLARIFY!]
45-
* ... reviews the pull request, changes
46-
* ... [DISCUSS WITH CONTRIBUTOR!]
47-
* ... approve / reject
48-
3. Contributor:
37+
* (demo of discussing and resolving a pull request)
38+
2. INT. Collaborator:
39+
* ... receives GitHub notification of "pull request" _(depends on user settings)_
40+
* ... reviews the pull request
41+
* ... discusses with ext. collaborator
42+
* ... approves / rejects
43+
3. EXT. Collaborator:
4944
* Option to delete fork
5045
* [RESYNC with latest changes from original repo]
5146

@@ -56,7 +51,20 @@ Relevant roles for phuse-org/phuse-scripts?
5651
4. resolve any conflicts
5752
5. "pull request" ... screenshots
5853
6. Now as above?
54+
55+
1. EXT. Collaborator:
56+
* ... Re-syncs with origin repo, so always working with up-to-date files. [Re-syncing requires command line](https://help.github.com/articles/syncing-a-fork/)
57+
* ... develops a new feature, extensive changes in own fork
58+
* ... creates "pull request" in the fork
59+
2. INT. Collaborator:
60+
* ... receives GitHub notification of "pull request" _(depends on user settings)_
61+
* ... reviews the pull request
62+
* ... discusses with contributor
63+
* (will advise EXT. to re-sync & try again, if it's clear s/he has not first pulled latest changes!)
64+
* ... approves / rejects
65+
5966
* Contributing without GitHub access
67+
* Via PhUSE Wiki, email to project leads
6068

6169
### Git workflow tutorials
6270

0 commit comments

Comments
 (0)