Skip to content

Commit

Permalink
Create CONTRIBUTING.md (#108)
Browse files Browse the repository at this point in the history
* Create CONTRIBUTING.md

* Update CONTRIBUTING.md
  • Loading branch information
swyxio authored and jaredpalmer committed May 24, 2019
1 parent 74c9a9d commit 779e156
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contributing to TSDX

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

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.

0 comments on commit 779e156

Please sign in to comment.