Skip to content

Commit ad18183

Browse files
committed
Add docs for hands-on
1 parent b82ac87 commit ad18183

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

docs/contributing/hands-on.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,40 +30,39 @@ Enter `hands-on` or `h` to create a new hands-on.
3030
Then, the script will prompt you for:
3131

3232
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?
3535

3636
{: .reference }
3737

3838
Refer to the [hands-on structure document](/developers/docs/architecture/hands-on-structure) for more information about the folder structure generated.
3939

4040
## Download setup
4141

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.
4343

4444
{: .reference }
4545

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)
4747

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.
4949

5050
These are some references for download setups for other exercises:
5151

52-
- [ignoring-somethings](https://raw.githubusercontent.com/git-mastery/exercises/refs/heads/main/ignoring_somethings/download.py)
53-
- [branch-bender](https://raw.githubusercontent.com/git-mastery/exercises/refs/heads/main/branch_bender/download.py)
52+
- [init-repo](https://raw.githubusercontent.com/git-mastery/exercises/refs/heads/main/hands_on/init_repo.py)
53+
- [add-files](https://raw.githubusercontent.com/git-mastery/exercises/refs/heads/main/hands_on/add_files.py)
5454

5555
### Download conventions
5656

5757
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
6059

6160
### Testing downloads
6261

6362
To test that your download script works, we have provided a script to simulate the download process in this repository for you to verify.
6463

6564
```bash
66-
./test-download.sh <your exercise folder>
65+
./test-download.sh <your hands-on name>
6766
```
6867

6968
You can find the downloaded repository under the `test-downloads/` folder.
@@ -78,5 +77,5 @@ Fill in all of the details necessary.
7877

7978
1. Hands-on discussion: <https://github.com/git-mastery/exercises/issues/44>
8079
2. Remote repository request: <https://github.com/git-mastery/exercises/issues/25>
81-
3. Hands-on PR:
80+
3. Hands-on PR: <https://github.com/git-mastery/exercises/pull/45>
8281

0 commit comments

Comments
 (0)