Skip to content

Commit 481ebbb

Browse files
authored
Merge pull request AdaGold#3 from AdaGold/be/add-fork-instruction
Add instructions to fork and add collaborators
2 parents 071fc0d + fce0ed5 commit 481ebbb

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,31 @@
33
In this exercise you will work with your group to get to full code coverage and fix any bugs that you find.
44

55
## Setup
6-
1. Clone a copy of this exercise. This command makes a new folder called `code-coverage-exercise`, and then puts the exercise into this new folder. You do not need to fork the repository.
6+
1. On [Github](https://github.com/AdaGold/code-coverage-exercise), click on the "Fork" button in the top right corner and fork the repository to your Github account. This will make a copy of the project in your Github account.
7+
8+
2. On Github, add the other member(s) of your team as collaborators to _your fork_ of the repository. To do this the student who forked the repository should first choose "Settings" from the top menu bar (underneath the bar with the "Pin" button), then under the "Access" heading select "Collaborators", then under "Manage access" select "Add people".
9+
10+
3. Clone a copy of this exercise. This command makes a new folder called `code-coverage-exercise`, and then puts the exercise into this new folder.
711

812
```bash
913
git clone ...
1014
```
1115

1216
Use `ls` to confirm there's a new project folder
1317

14-
2. Move your location into this project folder
18+
4. Move your location into this project folder
1519

1620
```bash
1721
cd code-coverage-exercise
1822
```
1923

20-
3. Create a virtual environment named `venv` for this project:
24+
5. Create a virtual environment named `venv` for this project:
2125

2226
```bash
2327
python3 -m venv venv
2428
```
2529

26-
4. Activate this environment:
30+
6. Activate this environment:
2731

2832
```bash
2933
source venv/bin/activate
@@ -34,14 +38,14 @@ Verify that you're in a python3 virtual environment by running:
3438
- `$ python --version` should output a Python 3 version
3539
- `$ pip --version` should output that it is working with Python 3
3640

37-
5. Install dependencies once at the beginning of this exercise with
41+
7. Install dependencies once at the beginning of this exercise with
3842

3943
```bash
4044
# Must be in activated virtual environment
4145
pip install -r requirements.txt
4246
```
4347

44-
6. Exit and re-enter the virtual enviornment with the following command. This is needed to ensure the correct version of pytest is used in the terminal.
48+
8. Exit and re-enter the virtual enviornment with the following command. This is needed to ensure the correct version of pytest is used in the terminal.
4549

4650
```bash
4751
deactivate && source venv/bin/activate

0 commit comments

Comments
 (0)