Skip to content

Commit

Permalink
Merge pull request amplication#2317 from amplication/fix/2316-contrib…
Browse files Browse the repository at this point in the history
…uting-add-more-details

fix(docs): add details to step 3 and update the clone link
  • Loading branch information
yuval-hazaz authored Feb 19, 2022
2 parents b2f3994 + bc3aa0f commit 3a5e465
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,24 @@ Fork the Amplication repository to your GitHub organization. This means that you
## Step 2: Clone the repository to your local machine

```
git clone https://github.com/amplication/amplication
git clone https://github.com/{your-GitHub-username}/amplication.git
```

## Step 3: Prepare the development environment

Set up and run the development environment on your local machine (for details, see the [ Development Environment (Local)](https://github.com/amplication/amplication/blob/master/README.md#development) section in the README.
Set up and run the development environment on your local machine:

**BEFORE** you run the following steps make sure:
1. You have typescript installed locally on you machine ```npm install -g typescript```
2. You are using node version: ^16.3.0 || ^14.0.0"
3. You are using npm version: ^8.1.0 || ^7.3.0"

```shell
cd amplication
npm install
npm run setup:dev
```

## Step 4: Create a branch

Expand Down

0 comments on commit 3a5e465

Please sign in to comment.