Skip to content

Commit e438e78

Browse files
committed
Updated contributing guide to follow gitflow
1 parent bc320d2 commit e438e78

File tree

1 file changed

+50
-17
lines changed

1 file changed

+50
-17
lines changed

CONTRIBUTING.md

Lines changed: 50 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,63 @@
22

33
## Developer setup
44

5-
Git clone the repository:
5+
* Create a [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the [PyScript-CLI github repository](https://github.com/pyscript/pyscript-cli/fork) to your own GitHub account.
66

7-
```shell
8-
git clone https://github.com/pyscript/pyscript-cli.git
9-
```
7+
* [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) your newly forked version of the PyScript-CLI repository onto your local development machine. For example, use this command in your terminal:
108

11-
(Recommended) Upgrade local pip:
9+
```sh
10+
git clone https://github.com/<YOUR USERNAME>/pyscript-cli
11+
```
1212

13-
```shell
14-
pip install --upgrade pip
15-
```
13+
> **WARNING**: In the URL for the forked PyScript-CLI repository, remember to replace
14+
`<YOUR USERNAME>` with your actual GitHub username.
1615

17-
Make a virtualenv and activate it:
16+
* Change into the root directory of your newly cloned `pyscript-cli` repository:
1817

19-
```shell
20-
python -m venv .venv
21-
source .venv/bin/activate
22-
```
18+
```sh
19+
cd pyscript-cli
20+
```
2321

24-
Install your local enviroment dependencies
22+
* Add the original PyScript-CLI repository as your `upstream` to allow you to keep your own fork up-to-date with the latest changes:
2523

26-
```shell
27-
pip install -e ".[dev]"
28-
```
24+
```sh
25+
git remote add upstream https://github.com/pyscript/pyscript-cli.git
26+
```
27+
28+
* If the above fails, try this alternative:
29+
30+
```sh
31+
git remote remove upstream
32+
```
33+
34+
```sh
35+
git remote add upstream [email protected]:pyscript/pyscript-cli.git
36+
```
37+
38+
* Pull in the latest changes from the main `upstream` PyScript repository:
39+
40+
```sh
41+
git pull upstream main
42+
```
43+
44+
* (Recommended) Upgrade local pip:
45+
46+
```shell
47+
pip install --upgrade pip
48+
```
49+
50+
* Make a virtualenv and activate it:
51+
52+
```shell
53+
python -m venv .venv
54+
source .venv/bin/activate
55+
```
56+
57+
* Install your local enviroment dependencies
58+
59+
```shell
60+
pip install -e ".[dev]"
61+
```
2962

3063
## Use the CLI
3164

0 commit comments

Comments
 (0)