Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
swyxio authored May 24, 2019
1 parent 779e156 commit 9cc322e
Showing 1 changed file with 39 additions and 6 deletions.
45 changes: 39 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,43 @@

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.

0. Make sure you dont have existing `tsdx` global installations that may conflict: `npm uninstall -g tsdx`.
1. Fork this repository to your own GitHub account and then clone it to your local device.
2. Install the dependencies: `yarn install`
3. Run `yarn build` to build the typescript files to javascript
4. Run `yarn link` to link the local repo to NPM
## Setup
0. First, remove any existing `tsdx` global installations that may conflict.

You can now use `tsdx` locally as you work on `tsdx` code. Be sure to run `yarn test` before you make your PR to make sure you haven't broken anything.
```
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:

```
yarn && yarn build
```

> **Note:** you'll need to run `yarn build` any time you want to see your changes.
3. 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:

```
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`.

## 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 9cc322e

Please sign in to comment.