Skip to content

Commit

Permalink
Add local dev docs
Browse files Browse the repository at this point in the history
  • Loading branch information
camden11 committed May 25, 2023
1 parent ae77fa7 commit 39d2194
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ cd /path/to/other-npm-package
yarn link @hubspot/cli
```

## Local development with cli-lib
When contributing to hubspot-cli, you may also need to make changes to cli-lib. To use a local version of cli-lib as a dependancy, use [yarn link](https://classic.yarnpkg.com/lang/en/docs/cli/link/).
1. Run `yarn link` in cli-lib to set up a symlink.
2. Run `yarn link @hubspot/cli-lib` in hubspot-cli to use the symlinked local package.

To stop using your local cli-lib, you can follow a similar process with [yarn unlink](https://classic.yarnpkg.com/en/docs/cli/unlink).

## Testing
Ensure you are on the minimum version of Node supported by the CLI before running any tests, since that is the version of node that the build step uses. To find the minimum,
Expand Down

0 comments on commit 39d2194

Please sign in to comment.