Skip to content

Commit 744fea8

Browse files
Lint: Update additional requirement for gitlint.
1 parent 385fb51 commit 744fea8

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,18 @@ and [commit guidelines](https://zulip.readthedocs.io/en/latest/contributing/vers
2424
1. Fork and clone the Git repo:
2525
`git clone https://github.com/<your_username>/python-zulip-api.git`
2626

27-
2. Make sure you have [pip](https://pip.pypa.io/en/stable/installing/)
27+
2. Setup upstream and fetch upstream/master (Required for Gitlint):
28+
- `git remote add upstream https://github.com/zulip/python-zulip-api.git`
29+
- `git fetch upstream master`
30+
31+
3. Make sure you have [pip](https://pip.pypa.io/en/stable/installing/)
2832
and [virtualenv](https://virtualenv.pypa.io/en/stable/installation.html)
2933
installed.
3034

31-
3. `cd` into the repository cloned earlier:
35+
4. `cd` into the repository cloned earlier:
3236
`cd python-zulip-api`
3337

34-
4. Run:
38+
5. Run:
3539
```
3640
python3 ./tools/provision
3741
```
@@ -42,14 +46,14 @@ and [commit guidelines](https://zulip.readthedocs.io/en/latest/contributing/vers
4246
python3 ./tools/provision -p <path_to_your_python_version>
4347
```
4448

45-
5. If that succeeds, it will end with printing the following command:
49+
6. If that succeeds, it will end with printing the following command:
4650
```
4751
source /.../python-zulip-api/.../activate
4852
```
4953
You can run this command to enter the virtual environment.
5054
You'll want to run this in each new shell before running commands from `python-zulip-api`.
5155

52-
6. Once you've entered the virtualenv, you should see something like this on the terminal:
56+
7. Once you've entered the virtualenv, you should see something like this on the terminal:
5357
```
5458
(zulip-api-py3-venv) user@pc ~/python-zulip-api $
5559
```

0 commit comments

Comments
 (0)