Skip to content

Commit 9f04bee

Browse files
Update CONTRIBUTING.md to provide robust localdev setup
1 parent 923d649 commit 9f04bee

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,28 @@ steps:
4040
2) [Fork the Git-Sim codebase](https://github.com/initialcommit-com/git-sim/fork)
4141
so that you have a copy on GitHub that you can clone and work with
4242
3) Clone the codebase down to your local machine
43-
4) For the code to run locally without getting a `ModuleNotFoundError`,
44-
install the developement package by running
43+
4) If you previously installed Git-Sim normally using pip, uninstall it first using:
44+
4545
```console
46-
$ cd git-sim
47-
$ python -m pip install --no-deps -e .
46+
$ pip uninstall git-sim
47+
```
48+
49+
5) To run the code locally from source, install the developement package by running:
50+
51+
```console
52+
$ cd path/to/git-sim
53+
$ python -m pip install -e .
4854
```
55+
4956
This will install sources from your cloned repo such that you can edit the source and the changes are reflected instantly.
5057

51-
1) You can run your local Git-Sim commands from within other local repos like this:
58+
If you already have the dependencies, you can ignore those using the `--no-deps` flag:
59+
60+
```console
61+
$ python -m pip install --no-deps -e .
62+
```
63+
64+
6) You can run your local Git-Sim commands from within other local repos like this:
5265

5366
```console
5467
$ git-sim [global options] <subcommand> [subcommand options]

0 commit comments

Comments
 (0)