Skip to content

Commit 33bb991

Browse files
mdojulien-deramond
andauthored
Docs: mention npm install and npm run dist in CONTRIBUTING.md (#41340)
Co-authored-by: Julien Déramond <[email protected]>
1 parent 9a01aa3 commit 33bb991

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

.github/CONTRIBUTING.md

+20-6
Original file line numberDiff line numberDiff line change
@@ -172,33 +172,47 @@ included in the project:
172172
git pull upstream main
173173
```
174174

175-
3. Create a new topic branch (off the main project development branch) to
175+
3. Install or update project dependencies with npm:
176+
177+
```bash
178+
npm install
179+
```
180+
181+
4. Create a new topic branch (off the main project development branch) to
176182
contain your feature, change, or fix:
177183

178184
```bash
179185
git checkout -b <topic-branch-name>
180186
```
181187

182-
4. Commit your changes in logical chunks. Please adhere to these [git commit
188+
5. Commit your changes in logical chunks. Please adhere to these [git commit
183189
message guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
184190
or your code is unlikely be merged into the main project. Use Git's
185191
[interactive rebase](https://help.github.com/articles/about-git-rebase/)
186192
feature to tidy up your commits before making them public.
187193

188-
5. Locally merge (or rebase) the upstream development branch into your topic branch:
194+
6. Ensure your changes compile the dist CSS and JS files in the `dist/` directory. Verify
195+
the build succeeds locally without errors.
196+
197+
```bash
198+
npm run dist
199+
```
200+
201+
7. Locally merge (or rebase) the upstream development branch into your topic branch:
189202

190203
```bash
191204
git pull [--rebase] upstream main
192205
```
193206

194-
6. Push your topic branch up to your fork:
207+
8. Commit your changes, but **do not push compiled CSS and JS files in `dist` and `js/dist`**.
208+
Push your topic branch up to your fork:
195209

196210
```bash
197211
git push origin <topic-branch-name>
198212
```
199213

200-
7. [Open a Pull Request](https://help.github.com/articles/about-pull-requests/)
201-
with a clear title and description against the `main` branch.
214+
9. [Open a pull request](https://help.github.com/articles/about-pull-requests/)
215+
with a clear title and description against the `main` branch.
202216

203217
**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
204218
license your work under the terms of the [MIT License](../LICENSE) (if it

0 commit comments

Comments
 (0)