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/architecture/hands-on-structure.md
+24-25Lines changed: 24 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,42 +12,41 @@ Hands-ons are not graded and the progress is not tracked. They are only present
12
12
13
13
{: .note }
14
14
15
-
Git-Mastery users will prefix`hp-` before the hands-on names, but internally, we do not use this prefix as the `hands_on` folder is sufficient for us.
15
+
Git-Mastery uses the format`hp-<hands-on-name>` for hands-on names (e.g., `hp-init-repo`), to differentiate them from exercise names. Internally, we use a `hands_on/` folder (instead of the `hp-` prefix) to differentiate hands-on files from exercise files (e.g., `hands_on/init_repo.py`).
16
16
17
17
## File structure
18
18
19
-
Since the hands-on is only comprised of a single file, there isn't a lot of complexity to it.
19
+
Since the hands-on is only comprised of a single file, there isn't a lot of complexity to it. Given below is an example:
20
20
21
21
```python
22
-
import subprocess
23
-
from sys importexit
24
-
from typing import List, Optional
22
+
import os
23
+
24
+
from exercise_utils.cli import run_command
25
+
from exercise_utils.file import append_to_file, create_or_update_file
The setup instructions of the hands-on go under `download`.
50
+
The setup instructions of the hands-on go under the `download` function.
52
51
53
52
`__requires_git__` and `__requires_github__` tells the Git-Mastery app whether to run automatic verification that the student has already setup Git and/or Github CLI correctly!
0 commit comments