Skip to content

Commit ecfd35e

Browse files
docs: Add set and fetch upstream.
Set and Fetch upstream is required for gitlint, while setting up development env.
1 parent 4c75057 commit ecfd35e

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,15 @@ This is part of the Zulip open source project; see the
2222
[contributing guide](https://zulip.readthedocs.io/en/latest/overview/contributing.html)
2323
and [commit guidelines](https://zulip.readthedocs.io/en/latest/contributing/version-control.html).
2424

25-
1. Fork and clone the Git repo:
25+
1. Fork and clone the Git repo, and set upstream to zulip/python-zulip-api:
2626
`git clone https://github.com/<your_username>/python-zulip-api.git`
27-
28-
2. Make sure you have [pip](https://pip.pypa.io/en/stable/installing/)
29-
and [virtualenv](https://virtualenv.pypa.io/en/stable/installation.html)
30-
installed.
31-
32-
3. `cd` into the repository cloned earlier:
3327
`cd python-zulip-api`
28+
`git remote add upstream https://github.com/zulip/python-zulip-api.git`
29+
`git fetch upstream master`
30+
31+
2. Make sure you have [pip](https://pip.pypa.io/en/stable/installing/).
3432

35-
4. Run:
33+
3. Run:
3634
```
3735
python3 ./tools/provision
3836
```
@@ -43,14 +41,14 @@ and [commit guidelines](https://zulip.readthedocs.io/en/latest/contributing/vers
4341
python3 ./tools/provision -p <path_to_your_python_version>
4442
```
4543

46-
5. If that succeeds, it will end with printing the following command:
44+
4. If that succeeds, it will end with printing the following command:
4745
```
4846
source /.../python-zulip-api/.../activate
4947
```
5048
You can run this command to enter the virtual environment.
5149
You'll want to run this in each new shell before running commands from `python-zulip-api`.
5250

53-
6. Once you've entered the virtualenv, you should see something like this on the terminal:
51+
5. Once you've entered the virtualenv, you should see something like this on the terminal:
5452
```
5553
(zulip-api-py3-venv) user@pc ~/python-zulip-api $
5654
```

0 commit comments

Comments
 (0)