Skip to content

Commit a90500f

Browse files
Updated contributing.md to update steps to run locally
Signed-off-by: Abhijit Nathwani <[email protected]>
1 parent 35288ff commit a90500f

File tree

1 file changed

+12
-26
lines changed

1 file changed

+12
-26
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -41,38 +41,24 @@ steps:
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
4343
4) For the code to run locally without getting a `ModuleNotFoundError`,
44-
you need to remove the import prefix `git_sim.` from imports (for example
45-
`from git_sim_base_command import GitSimBaseCommand`) in the following files:
46-
47-
- __main.py__
48-
- git_sim.py
49-
- git_sim_add.py
50-
- git_sim_branch.py
51-
- git_sim_cherrypick.py
52-
- git_sim_commit.py
53-
- git_sim_log.py
54-
- git_sim_merge.py
55-
- git_sim_rebase.py
56-
- git_sim_reset.py
57-
- git_sim_restore.py
58-
- git_sim_revert.py
59-
- git_sim_stash.py
60-
- git_sim_status.py
61-
- git_sim_tag.py
62-
63-
There is probably a way around this. When I figure it out I'll update this guide.
64-
65-
5) You can run your local Git-Sim commands from within other local repos like this:
66-
44+
install the developement package by running
45+
```console
46+
$ cd git-sim
47+
$ python setup.py develop
6748
```
68-
$ python ~/path/to/git-sim/git_sim/__main__.py [global options] <subcommand> [subcommand options]
49+
This will install sources from your cloned repo such that you can edit the source and the changes are reflected instantly.
50+
51+
1) You can run your local Git-Sim commands from within other local repos like this:
52+
53+
```console
54+
$ git-sim [global options] <subcommand> [subcommand options]
6955
```
7056

7157
For example, you can simulate the `git add` command locally like this:
7258

73-
```
59+
```console
7460
$ cd path/to/any/local/git/repo
75-
$ python ~/path/to/git-sim/git_sim/__main__.py --animate add newfile.txt
61+
$ git-sim --animate add newfile.txt
7662
```
7763

7864
6) After pushing your code changes up to your fork, [submit a pull request](https://github.com/initialcommit-com/git-sim/compare) for me

0 commit comments

Comments
 (0)