Skip to content

Commit

Permalink
docs: improve testing steps
Browse files Browse the repository at this point in the history
  • Loading branch information
privatenumber committed Mar 10, 2023
1 parent 0ebb251 commit 69e2470
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,17 +56,20 @@ pnpm test


## Using & testing your changes
You can publish the package to a GitHub branch using [`git-publish`](https://github.com/privatenumber/git-publish):

Publish your current branch to a GitHub branch:
Let's say you made some changes in a fork/branch and you want to test it in a project. You can publish the package to a GitHub branch using [`git-publish`](https://github.com/privatenumber/git-publish):

Publish your current branch to a `npm/*` branch on your GitHub repository:
```sh
$ npx git-publish
$ pnpm dlx git-publish

✔ Successfully published branch! Install with command:
→ npm i 'Nutlope/aicommits#npm/develop'
```

Then you can use the output to test the changes:
> Note: The `Nutlope/aicommits` will be replaced with your fork's URL.
Now, you can run the branch in your project:
```sh
$ npx 'Nutlope/aicommits#npm/develop' # same as running `npx aicommits`
$ pnpm dlx 'Nutlope/aicommits#npm/develop' # same as running `npx aicommits`
```

0 comments on commit 69e2470

Please sign in to comment.