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
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,16 +69,15 @@ If you would like to work on a new core feature or improvement, first create a [
69
69
70
70
## Control Panel Front End
71
71
72
-
In order to work on the control panel front end, you'll want to spin up two terminal windows. Run `npm run dev` in one, and `npm run dev:cp` in the other. That will start the main Vite process as well as the Vite process for the `@craftcms/cp` package.
72
+
In order to work on the control panel front end, we recommend opening two terminal windows. Run `npm run dev` in one, and `npm run dev:cp` in the other. That will start the main Vite process as well as the Vite process for the `@craftcms/cp` package.
73
73
74
74
With both running, you'll be able to work on most aspects of the control panel.
75
75
76
76
If getting into the weeds is your thing, more detail on these pieces is provided below.
77
77
78
78
### CP assets
79
79
80
-
The assets specific to the CP live in the `resources` folder. Those are built using a fairly typical Vite setup. To develop assets for the CP there are two commands:
81
-
80
+
The assets specific to the CP live in the `resources` folder. Those are built using a fairly typical Vite setup. To develop assets for the CP, there are two commands:
82
81
```shell
83
82
# Run the vite development server
84
83
npm run dev
@@ -90,7 +89,6 @@ npm run build
90
89
### `@craftcms/cp` package
91
90
92
91
The CP is largely backed by web components that live in the `@craftcms/cp` package within the `packages/craftcms-cp` directory. Like other packages, it has its own build process that can be run independently of the CP.
93
-
94
92
```shell
95
93
# Run the build in watch mode. Assets will be rebuilt on every change
96
94
npm run dev:cp
@@ -106,8 +104,7 @@ In practice, you rarely work on one without the other, so we recommend having tw
106
104
> [!NOTE]
107
105
> Updating the legacy bundles should be a rare occurrence. Avoid when possible.
108
106
109
-
ALl of the styles and scripts used to support the CP up until Craft 5 live in the [yii2-adapter](https://github.com/craftcms/yii2-adapter) package. That package has its own NPM dependencies and build process, but because it's common to have that package symlinked into your Craft 6 project you're able to run the build scripts via the `build:bundles` command.
110
-
107
+
All of the styles and scripts used to support the CP up until Craft 5 live in the [yii2-adapter](https://github.com/craftcms/yii2-adapter) package. That package has its own NPM dependencies and build process, but because it's common to have that package symlinked into your Craft 6 project, you're able to run the build scripts via the `build:bundles` command.
0 commit comments