Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc: Improve contributing documentation #499

Merged
merged 1 commit into from
Nov 30, 2022
Merged

Doc: Improve contributing documentation #499

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
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