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: .github/CONTRIBUTING.md
+10-26Lines changed: 10 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,6 @@ Table of Contents
11
11
-[Your first Contribution](#your-first-contribution)
12
12
-[Setup](#setup)
13
13
-[Running Tests](#running-tests)
14
-
-[Using yarn](#using-yarn)
15
14
-[Editor Config](#editor-config)
16
15
-[Dependencies](#dependencies)
17
16
-[Branching Model](#branching-model)
@@ -53,71 +52,58 @@ In case you are suggesting a new feature, we will match your idea with our curre
53
52
## Setup
54
53
55
54
- Install [Node.js](https://nodejs.org/) if you don't have it already.
56
-
_Note: Node 6 or greater would be better for "best results"._
57
-
- Fork the **webpack-cli** repo at [https://github.com/webpack/webpack-cli](https://github.com/webpack/webpack-cli).
58
-
-`git clone <your-clone-url> && cd webpack-cli`
59
-
60
-
- We use [yarn](https://yarnpkg.com/lang/en/) workspaces, please install it:
55
+
_Note: Node 22 or greater would be better for "best results"._
61
56
62
-
Read the [Installation Guide](https://yarnpkg.com/en/docs/install) on their official website for detailed instructions on how to install Yarn.
57
+
- Fork the **webpack-cli** repo at [https://github.com/webpack/webpack-cli](https://github.com/webpack/webpack-cli).
63
58
64
-
> Using yarn is not a requirement, [npm](https://www.npmjs.com/) is included in node.
59
+
-`git clone <your-clone-url> && cd webpack-cli`
65
60
66
61
- Install the dependencies:
67
62
68
63
```bash
69
-
yarn install
64
+
npm install
70
65
```
71
66
72
67
- Build all the submodules before building for the first time
73
68
74
69
```bash
75
-
yarn build
70
+
npm run build
76
71
```
77
72
78
73
> If you are a Docker and Visual Studio Code user, you can quickstart development using [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) Extension
79
74
80
75
## Running Tests
81
76
82
-
### Using yarn
83
-
84
77
- Run all the tests with:
85
78
86
79
```bash
87
-
yarntest
80
+
npm runtest
88
81
```
89
82
90
83
- Run CLI tests with:
91
84
92
85
```bash
93
-
yarn test:cli
86
+
npm run test:cli
94
87
```
95
88
96
89
- Run tests of all packages:
97
90
98
91
```bash
99
-
yarn test:packages
92
+
npm run test:packages
100
93
```
101
94
102
95
- Test a single CLI test case:
103
96
104
97
> Must run from root of the project
105
98
106
99
```bash
107
-
yarn jest path/to/my-test.js
108
-
```
109
-
110
-
- You can also install jest globally and run tests without npx:
111
-
112
-
```bash
113
-
yarn global add jest
114
100
jest path/to/my-test.js
115
101
```
116
102
117
103
- You can run the linters:
118
104
119
105
```bash
120
-
yarn lint
106
+
npm run lint
121
107
```
122
108
123
109
## Editor Config
@@ -128,8 +114,6 @@ The [.editorconfig](https://github.com/webpack/webpack-cli/blob/main/.editorconf
128
114
129
115
This is a multi-package repository and dependencies are managed using [lerna](https://lerna.js.org/)
130
116
131
-
> If you are adding or updating any dependency, please commit the updated `yarn.lock` file.
132
-
133
117
To update dependencies, import each dependency and make sure the command line build passes. The dependency should support our minimal supported node version for webpack, found in `package.json`.
134
118
135
119
## Branching Model
@@ -249,7 +233,7 @@ documentation.
249
233
250
234
## Releasing
251
235
252
-
Run `yarn publish:monorepo` to build all packages and bump versions, this will then get published on npm.
236
+
Run `npm run publish:monorepo` to build all packages and bump versions, this will then get published on npm.
0 commit comments