Skip to content

Commit 422670f

Browse files
committed
update readme
1 parent fec5a42 commit 422670f

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
# Exercise to practice collaborative forking workflow
1+
### Exercise to practice collaborative forking workflow
22

33
We will run this exercise in groups and we number the groups
44
1, 2, ..., etc.
55

6-
7-
## Objectives
6+
Objectives:
87

98
- Learn how to fork, modify the fork, and file a pull request towards forked repo
109
- Learn how to update your fork with upstream changes
1110

1211

13-
## First part: Fork, clone, and modify
12+
#### First part: Fork, clone, and modify
1413

15-
First fork this repository and then clone the fork.
14+
First fork this repository ion GitHub into your namespace and then clone the fork to your computer.
1615

1716
Then add a file `groupN.py` where N is your group number, e.g. `group17.py`.
1817

1918
This file should contain a function called `tweet()` which returns
2019
a string of maximum 140 characters, for instance:
20+
2121
```python
2222
def tweet():
2323
return "please replace this boring sentence with something more fun"
@@ -27,31 +27,33 @@ The file `main.py` automatically calls all `tweet()` functions defined in files
2727
`groupN.py` (1 <= N <= 50). You do not need to edit `main.py`.
2828

2929
You can test it:
30-
```
30+
31+
```shell
3132
$ python main.py
3233

3334
group 17 says: please replace this boring sentence with something more fun
3435
```
3536

36-
Once you see your sentence correctly printed, commit and push. Don't worry
37+
Once you see your sentence correctly printed, commit and push to your fork. Don't worry
3738
nothing gets out to Twitter but please mind that your changes will be public on
3839
GitHub (but you can delete them later).
3940

4041

41-
## Second part: File a pull request
42+
#### Second part: File a pull request
4243

4344
Then file a pull request towards the repository where you forked from.
4445

4546
Wait until we integrate all pull requests into the central repo
46-
together.
47+
together on the big screen.
4748

4849

49-
## Third part: Update your fork
50+
#### Third part: Update your fork
5051

5152
We do this part **after the contributions from all groups have been integrated**.
5253

5354
Once this is done, practice to update your forked repo with the upstream
5455
changes and verify that you got the files created by other groups:
55-
```
56+
57+
```shell
5658
$ python main.py
5759
```

0 commit comments

Comments
 (0)