From 8125d7405780eda08147c95b7a8e5652aa90ec72 Mon Sep 17 00:00:00 2001 From: Aaron Date: Fri, 31 May 2024 01:32:16 -0500 Subject: [PATCH] docs: Update contributing guidelines --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5244b94..36a22129 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,13 +37,13 @@ pnpm build ```sh # Build WXT package, then build demo extension -cd demo +cd packages/wxt-demo pnpm build ``` ```sh # Build WXT package, then start the demo extension in dev mode -cd demo +cd packages/wxt-demo pnpm dev ``` @@ -75,7 +75,7 @@ To run tests for a specific file, add the filename at the end of the test comman pnpm test manifest-contents ``` -Unit and E2E tests are ran together via [Vitest workspaces](https://vitest.dev/guide/#workspaces-support). +All test (unit and E2E) for all packages are ran together via [Vitest workspaces](https://vitest.dev/guide/#workspaces-support). If you want to manually test a change, you can modify the demo project for your test, but please don't leave those changes committed once you open a PR. @@ -90,7 +90,7 @@ npm run dev npm run build ``` -Note that templates are hardcoded to a specific version of `wxt` from NPM, they do not use the local version. PR checks will test your changes against the templates, but if you want to manually do it, update the package.json dependency: +Note that templates are hardcoded to a specific version of `wxt` from NPM, they do not use the local version. PR checks will test your PR's changes against the templates, but if you want to manually do it, update the package.json dependency: ```diff "devDependencies": {