Skip to content

Commit 4b9f71c

Browse files
Update contribution guidelines to utilize dev branch
Signed-off-by: Jacob Stopak <jacob@initialcommit.io>
1 parent 421aa1d commit 4b9f71c

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,14 @@ 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) If you previously installed Git-Sim normally using pip, uninstall it first using:
43+
4) Checkout and commit new work to the `dev` branch
44+
5) If you previously installed Git-Sim normally using pip, uninstall it first using:
4445

4546
```console
4647
$ pip uninstall git-sim
4748
```
4849

49-
5) To run the code locally from source, install the development package by running:
50+
6) To run the code locally from source, install the development package by running:
5051

5152
```console
5253
$ cd path/to/git-sim
@@ -61,7 +62,7 @@ If you already have the dependencies, you can ignore those using the `--no-deps`
6162
$ python -m pip install --no-deps -e .
6263
```
6364

64-
6) You can run your local Git-Sim commands from within other local repos like this:
65+
7) You can run your local Git-Sim commands from within other local repos like this:
6566

6667
```console
6768
$ git-sim [global options] <subcommand> [subcommand options]
@@ -74,8 +75,8 @@ $ cd path/to/any/local/git/repo
7475
$ git-sim --animate add newfile.txt
7576
```
7677

77-
6) After pushing your code changes up to your fork, [submit a pull request](https://github.com/initialcommit-com/git-sim/compare) for me
78-
to review your code, provide feedback, and integrate it into the codebase!
78+
8) After pushing your code changes up to your fork, [submit a pull request to the `dev` branch](https://github.com/initialcommit-com/git-sim/compare) for me
79+
to review your code, provide feedback, and merge it into the codebase!
7980

8081
## Code style guide
8182

0 commit comments

Comments
 (0)