Skip to content

Commit f8cd424

Browse files
LoopThrough-i-jtimabbott
authored andcommittedMar 4, 2021
docs: Add set and fetch upstream.
Set and Fetch upstream is required for gitlint, while setting up development env.
1 parent 44b6fd3 commit f8cd424

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed
 

‎README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@ 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:
26-
`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.
25+
1. Fork and clone the Git repo, and set upstream to zulip/python-zulip-api:
26+
```
27+
git clone https://github.com/<your_username>/python-zulip-api.git
28+
cd python-zulip-api
29+
git remote add upstream https://github.com/zulip/python-zulip-api.git
30+
git fetch upstream
31+
```
3132

32-
3. `cd` into the repository cloned earlier:
33-
`cd python-zulip-api`
33+
2. Make sure you have [pip](https://pip.pypa.io/en/stable/installing/).
3434

35-
4. Run:
35+
3. Run:
3636
```
3737
python3 ./tools/provision
3838
```
@@ -43,14 +43,14 @@ and [commit guidelines](https://zulip.readthedocs.io/en/latest/contributing/vers
4343
python3 ./tools/provision -p <path_to_your_python_version>
4444
```
4545

46-
5. If that succeeds, it will end with printing the following command:
46+
4. If that succeeds, it will end with printing the following command:
4747
```
4848
source /.../python-zulip-api/.../activate
4949
```
5050
You can run this command to enter the virtual environment.
5151
You'll want to run this in each new shell before running commands from `python-zulip-api`.
5252

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

0 commit comments

Comments
 (0)
Please sign in to comment.