You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/hands-on.md
+10-11Lines changed: 10 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,40 +30,39 @@ Enter `hands-on` or `h` to create a new hands-on.
30
30
Then, the script will prompt you for:
31
31
32
32
1. The name of the hands-on -- likely to be specified in the corresponding hands-on discussion (you should be using kebab case for the hands-on name)
33
-
2. Does the exercise require Git?
34
-
3. Does the exercise require Github?
33
+
2. Does the hands-on require Git?
34
+
3. Does the hands-on require Github?
35
35
36
36
{: .reference }
37
37
38
38
Refer to the [hands-on structure document](/developers/docs/architecture/hands-on-structure) for more information about the folder structure generated.
39
39
40
40
## Download setup
41
41
42
-
The `download.py` contains the instructions to setup the local repository.
42
+
Hands-on downloads are all single-file stored in `hands_on/`. The `<hands on name>.py` contains the instructions to setup the local repository.
43
43
44
44
{: .reference }
45
45
46
-
For more information about how Git-Mastery downloads exercises, refer to the [Download Workflow](/developers/docs/architecture/download-workflow)
46
+
For more information about how Git-Mastery downloads hands-on, refer to the [Download Workflow](/developers/docs/architecture/download-workflow)
47
47
48
-
The default download script comes with a helper function to `run_command` to run local command, and a command to attach a tag as the "start tag". This is only useful if you want to iterate through the user's commits in your verification script. Otherwise, this can be removed.
48
+
The default download script comes with a helper function to `run_command` to run local command.
49
49
50
50
These are some references for download setups for other exercises:
1. Any operations should use OS agnostic options (e.g. opting to use `shutil.rmtree` over `run_command(["rm"])`)
58
-
2. If you need to compare the states before and after the student has started to add commits, use the given "start tag" as `git-autograder` is designed to read that if necessary
59
-
3. For any commands that require `gh` (Github CLI), make sure that the `requires_github` configuration is set to `true` so that the app will automatically check that the student has correctly setup Github CLI
58
+
2. For any commands that require `gh` (Github CLI), make sure that the `__requires_github__` variable in the download setup is set to `True` so that the app will automatically check that the student has correctly setup Github CLI
60
59
61
60
### Testing downloads
62
61
63
62
To test that your download script works, we have provided a script to simulate the download process in this repository for you to verify.
64
63
65
64
```bash
66
-
./test-download.sh <your exercise folder>
65
+
./test-download.sh <your hands-on name>
67
66
```
68
67
69
68
You can find the downloaded repository under the `test-downloads/` folder.
@@ -78,5 +77,5 @@ Fill in all of the details necessary.
0 commit comments