Skip to content

Commit

Permalink
Doc: Improve contributing documentation (#499)
Browse files Browse the repository at this point in the history
In the doc it mentions to go to subfolder of examples but it was not
there :).

Signed-off-by: Federico Guerinoni <guerinoni.federico@gmail.com>

Signed-off-by: Federico Guerinoni <guerinoni.federico@gmail.com>
  • Loading branch information
guerinoni authored Nov 30, 2022
1 parent 80f8e12 commit c2fa52c
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ are always appreciated!
You can use Docker and docker-compose to test shuttle locally during development. See the [Docker install](https://docs.docker.com/get-docker/)
and [docker-compose install](https://docs.docker.com/compose/install/) instructions if you do not have them installed already.

```bash
git clone git@github.com:shuttle-hq/shuttle.git
cd shuttle
```

You should now be ready to setup a local environment to test code changes to core `shuttle` packages as follows:

Build the required images with:
Expand Down Expand Up @@ -61,6 +66,8 @@ cargo run --bin cargo-shuttle -- login --api-key "test-key"
cd into one of the examples:

```bash
git submodule init
git submodule update
cd examples/rocket/hello-world/
```

Expand Down

0 comments on commit c2fa52c

Please sign in to comment.