You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+17-16Lines changed: 17 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ If you are here to suggest a feature, feel free to [start a discussion](https://
19
19
The fastest way to work on the repository is by using [Stackblitz's Codeflow](https://stackblitz.com/codeflow)
20
20
21
21
1. Click the `Open in Codeflow` button on this repo's README (or go directly to [this link](https:///pr.new/RyanClementsHax/tailwindcss-themer))
22
-
2. Run the build using `npm run watch`
22
+
2. Run the build using `pnpm run watch`
23
23
3. Implement your changes and tests to files in the `src/` directory and corresponding test files
24
24
4. Use the example repos to integration test changes
25
25
5. Document your changes in the appropriate doc page
@@ -31,35 +31,36 @@ The fastest way to work on the repository is by using [Stackblitz's Codeflow](ht
31
31
If you prefer to not use Stackblitz for faster development, you can still do this the old fashioned way.
32
32
33
33
1. Fork this repository
34
-
2. Install dependencies by running `npm install`
35
-
3. Run the build using `npm run watch`
36
-
4. Implement your changes and tests to files in the `src/` directory and corresponding test files
37
-
5. Use the example repos to integration test changes
38
-
6. Document your changes in the appropriate doc page
39
-
7. Git stage your required changes and commit (see below commit guidelines)
40
-
8. Submit PR for review
34
+
2.[Install pnpm](https://pnpm.io/installation)
35
+
3. Install dependencies by running `pnpm install`
36
+
4. Run the build using `pnpm run watch`
37
+
5. Implement your changes and tests to files in the `src/` directory and corresponding test files
38
+
6. Use the example repos to integration test changes
39
+
7. Document your changes in the appropriate doc page
40
+
8. Git stage your required changes and commit (see below commit guidelines)
41
+
9. Submit PR for review
41
42
42
43
### Running examples
43
44
44
45
All examples are located in the `examples` directory of this repo.
45
46
46
-
1. Run `npm run watch` in the root of `tailwindcss-themer` to build the plugin and watch for any changes
47
+
1. Run `pnpm run watch` in the root of `tailwindcss-themer` to build the plugin and watch for any changes
47
48
2. Replace the `"tailwindcss-themer": "latest"` line in the example project's `package.json` with `"tailwindcss-themer": "file:../../"`
48
-
3. Run`npm install` in the repo's root directory
49
-
4. Run `npm run start` in the selected example's directory
50
-
5. After making a change to the plugin, restart the example's server (i.e. rerun `npm run start`) so that it picks up the changes
49
+
3. Run`pnpm install` in the repo's root directory
50
+
4. Run `pnpm run start` in the selected example's directory
51
+
5. After making a change to the plugin, restart the example's server (i.e. rerun `pnpm run start`) so that it picks up the changes
51
52
52
53
### Running e2e tests
53
54
54
55
For e2e testing we use [Playwright](https://playwright.dev/).
55
56
56
-
1. Run `npm install` to install dependencies
57
-
2. Run `npm run build` to build the plugin
57
+
1. Run `pnpm install` to install dependencies
58
+
2. Run `pnpm run build` to build the plugin
58
59
3. Change directories to the `e2e` directory
59
-
4. Run `npm install` to install the playwright dependencies and browsers
60
+
4. Run `pnpm install` to install the playwright dependencies and browsers
60
61
- This step should handle setting up playwright but if this isn't working, their [documentation](https://playwright.dev/python/docs/intro) for more help on setting up your environment
61
62
- If you use WSL, you might find [this comment](https://github.com/microsoft/playwright/issues/13533#issuecomment-1098391029) to be helpful
0 commit comments