Skip to content

Commit

Permalink
Run prettier on contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredpalmer committed May 31, 2019
1 parent c7f58a1 commit 0cd316c
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,42 +3,42 @@
Thanks for your interest in TSDX! You are very welcome to contribute. If you are proposing a new feature, make sure to [open an issue](https://github.com/palmerhq/tsdx/issues/new/choose) to make sure it is inline with the project goals.

## Setup

0. First, remove any existing `tsdx` global installations that may conflict.

```
yarn global remove tsdx # or npm uninstall -g tsdx
```

1. Fork this repository to your own GitHub account and clone it to your local device:

```
git clone https://github.com/your-name/tsdx.git
cd tsdx
```
2. Install the dependencies and build the Typescript files to Javascript:

1. Install the dependencies and build the Typescript files to Javascript:

```
yarn && yarn build
```

> **Note:** you'll need to run `yarn build` any time you want to see your changes, or run `yarn watch` to leave it in watch mode.
3. Make it so running `tsdx` anywhere will run your local dev version:
1. Make it so running `tsdx` anywhere will run your local dev version:

```
yarn link
```


4. To use your local version when running `yarn build`/`yarn start`/`yarn test` in a TSDX project, run this in the project:
4) To use your local version when running `yarn build`/`yarn start`/`yarn test` in a TSDX project, run this in the project:

```
yarn link tsdx
```
You should see a success message: `success Using linked package for "tsdx".` The project will now use the locally linked version instead of a copy from `node_modules`.

You should see a success message: `success Using linked package for "tsdx".` The project will now use the locally linked version instead of a copy from `node_modules`.

## Submitting a PR

Be sure to run `yarn test` before you make your PR to make sure you haven't broken anything.

0 comments on commit 0cd316c

Please sign in to comment.