Skip to content

Commit 6f4bd9e

Browse files
authored
Update setup instructions and links in documentation (#5)
1 parent 44bdeef commit 6f4bd9e

File tree

2 files changed

+16
-33
lines changed

2 files changed

+16
-33
lines changed

docs/contributing/setup.md

Lines changed: 13 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -7,44 +7,27 @@ nav_order: 1
77
Both hands-on and exercises reside in the same repository: [`git-mastery/exercises`](https://github.com/git-mastery/exercises). So before you start to contributing, you should have these setup already:
88

99
- Bash environment
10-
- Python 3.13
10+
- Python 3.13+
1111
- Github CLI [installed and authenticated](https://github.com/cli/cli#installation) for testing the download script
12+
- uv [installed](https://docs.astral.sh/uv/getting-started/installation/)
1213

1314
## Setup
1415

1516
1. Fork the repository: <https://github.com/git-mastery/exercises>
1617
2. Clone the fork
1718

18-
```bash
19-
git clone https://github.com/<username>/exercises
20-
```
19+
```bash
20+
git clone https://github.com/<username>/exercises
21+
```
2122

22-
3. Setup a virtual environment
23+
3. Run the following command to set up virtual environment and install dependencies:
2324

24-
```bash
25-
python -m venv venv
26-
```
25+
```bash
26+
uv sync
27+
```
2728

28-
4. Activate the virtual environment
29+
4. Set up pre-commit hooks (for linting, formatting and type checking) using LeftHook
2930

30-
```bash
31-
source venv/bin/activate
32-
```
33-
34-
If you are using Windows, you should run the following instead:
35-
36-
```bash
37-
source venv/Scripts/activate
38-
```
39-
40-
5. Install all dependencies
41-
42-
```bash
43-
pip install -r requirements.txt
44-
```
45-
46-
6. Install pre-commit hooks using LeftHook (installed as a dependency in `requirements.txt`)
47-
48-
```bash
49-
lefthook install
50-
```
31+
```bash
32+
uv run lefthook install
33+
```

index.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ Git-Mastery is a Git education tool developed by the National University of Sing
1717

1818
Before contributing to Git-Mastery, it would be good if you tried it out to get a sense of what students experience.
1919

20-
To setup Git-Mastery, refer to [this setup guide](https://git-mastery.github.io/app) for your OS.
20+
To setup Git-Mastery, refer to [this setup guide](https://git-mastery.org/companion-app/index.html) for your OS.
2121

22-
We recommend following along with [tour 1](https://nus-cs2103-ay2526s1.github.io/website/book/gitAndGithub/trail/recordingFolderHistory/index.html) and [tour 2](https://nus-cs2103-ay2526s1.github.io/website/book/gitAndGithub/trail/backingUpOnCloud/) of the NUS CS2103/T Git curriculum!
22+
We recommend following along with [tour 1](https://git-mastery.org/lessons/trail/recordingFolderHistory/) and [tour 2](https://git-mastery.org/lessons/trail/backingUpOnCloud/) of the Git-Mastery curriculum!
2323

2424
## Contributor's progression
2525

26-
You are welcome to start contributing to Git-Mastery in any way you see fit!
26+
You are welcome to start contributing to Git-Mastery in any way you see fit!
2727

2828
However, if you are looking for a certain angle to start at, we recommend [contributing 1-2 hands-on](/developers/docs/contributing/hands-on) before diving into [contributing exercises](/developers/docs/contributing/exercise)!
2929

0 commit comments

Comments
 (0)