From 69e24709c5b1c0964a9b8e350392443e2dfd2291 Mon Sep 17 00:00:00 2001 From: Hiroki Osame Date: Fri, 10 Mar 2023 23:06:16 +0900 Subject: [PATCH] docs: improve testing steps --- CONTRIBUTING.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b7206d..97eb86b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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` ```