Skip to content

Commit f45127e

Browse files
committed
Update Git_workflow_exercises.md
develop 2 GitHub exercises
1 parent 858324b commit f45127e

File tree

1 file changed

+30
-31
lines changed

1 file changed

+30
-31
lines changed

Diff for: docs/guides/Git_workflow_exercises.md

+30-31
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,45 @@
11
### GitHub workflows
22

3-
**Objective:** put together workflow proposal (including Roles) for review by WG leads
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)
44

5-
**Pick a location:** Here in GitHub (makes sense), or [in Phusewiki](http://www.phusewiki.org/wiki/index.php?title=WG5_Project_02_GitHub_Exercises)?
6-
7-
1. TO DO: Hanming - What can "Owners" or "Team Maintainer" do specifically for the phuse-scripts repository? (Reference: https://help.github.com/articles/repository-permission-levels-for-an-organization/)
8-
2. Moderator - can change central code (Hanming - clarify)
9-
3. Contributors - "pull request" suggested code to the project committers (Hanming - clarify)
5+
Relevant roles for phuse-org/phuse-scripts are:
6+
1. Admin
7+
2. Developer
8+
3. ? [our repo teams](https://github.com/phuse-org/phuse-scripts/settings/collaboration) -- Owner? Admin? Is this the right setup?
109

10+
### Objective
11+
Script GitHub workflow exercises for CSS 2016.
1112

1213
### Git workflow tutorials
1314

14-
* [Atlassian Git Workflows](http://www.atlassian.com/git/tutorials/comparing-workflows)
15-
* [Learn git on Codecademy](http://www.codecademy.com/learn/learn-git)
15+
* [Atlassian Git Workflows](http://www.atlassian.com/git/tutorials/comparing-workflows)
16+
* [Learn git on Codecademy](http://www.codecademy.com/learn/learn-git)
1617

17-
(for setup, see [Contributor_setup.md](https://github.com/phuse-org/phuse-scripts/blob/master/docs/guides/Contributor_Setup.md))
18+
### GitHub Roles
1819

19-
#### Setup & Considerations
20+
[GitHub article on Repository Permission Levels](https://help.github.com/articles/repository-permission-levels-for-an-organization/)
2021

21-
* What team configuration do we want?
22-
* **Open:** Anyone that asks can be a team member and therefore change files in this repository
23-
* **Maintained:** Relatively few "maintainers" that must integrate any proposed changes, and can promote engaged contributors to team members. (Maintainers "protect" production-ready state of master branch.)
24-
* training folder, for scripted exercises
25-
* sequence: contribute-edit-"commit"-"sync"-another_edit
22+
1. phuse-or/phuse-scripts Maintainers: can change master code
23+
2. GitHub Contributors: can create "pull request" from their own branch, for the Maintainers to review
2624

27-
#### GitHub Roles
25+
#### phuse-or/phuse-scripts Setup
2826

29-
1. GitHub browser, without account
30-
2. GitHub member, without phuse-scripts membership
31-
3. phuse-scripts team member
32-
4. phuse-scripts maintainer
27+
* Master branch is always "production ready"
28+
* Therefore relatively few "Developers", who
29+
* have "write access", and can therefore
30+
* review "pull requests" and commit changes to master branch
31+
* There are also "Admins" who can
32+
* can promote engaged contributors to the "Developers" team
3333

3434
#### GitHub Exercises
3535

36-
##### Contributors
37-
38-
1. GitHub browser submits a change
39-
2. GitHub member submits isolated changes from their local repository. (Maintainer reviews and either Rejects or Incorporates.)
40-
3. 2 contributors make related changes (edit same file, move file, etc.). What do they see in GitHub?
41-
42-
##### Advanced / Maintainers
43-
44-
Advanced topics, as tutorials for project Maintainers.
45-
46-
**NB:** Avoid unnecessary complexity, such as Branches.
36+
* Simple steps: Suggest a change to an UNmodified file on the master branch
37+
1. ? Clone the repository
38+
2. modify file
39+
3. "pull request" ... screenshots
40+
* Substantial change (takes some time)
41+
1. ? Create a branch
42+
2. develop modules
43+
3. "pull" changes from master branch
44+
4. resolve any conflicts
45+
5. "pull request" ... screenshots

0 commit comments

Comments
 (0)