Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add directions to run docs and benchmarks #3092

Merged
merged 4 commits into from
Apr 15, 2024
Merged

docs: add directions to run docs and benchmarks #3092

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b85a2b9
docs: add directions to run docs and benchmarks
FatumaA Apr 11, 2024
04daf0b
Merge branch 'main' into docs-add-more-info-to-the-contributing-guide
Uzlopak Apr 13, 2024
eccf2f8
undo unneeded formatting
FatumaA Apr 15, 2024
93f9709
Update CONTRIBUTING.md
FatumaA Apr 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 25 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,16 @@
* [Releases](#releases)
* [Update `WPTs`](#update-wpts)
* [Building for externally shared node builtins](#external-builds)
* [Benchmarks](#benchmarks
* [Documentation](#documentation)
* [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin)
* [Moderation Policy](#moderation-policy)

<a id="guides"></a>
## Guides

This is a collection of guides on how to run and update `undici`, and how to run different parts of the project.

<a id="update-llhttp"></a>
### Update `llhttp`

Expand All @@ -36,6 +40,7 @@ git clone git@github.com:nodejs/llhttp.git

cd llhttp
```

#### Checkout a `llhttp` release

```bash
Expand Down Expand Up @@ -109,6 +114,7 @@ git sparse-checkout add /mimesniff
git sparse-checkout add /storage
git sparse-checkout add /service-workers
```

</details>

#### Sparse-clone the [wpt](https://github.com/web-platform-tests/wpt) repo
Expand Down Expand Up @@ -146,7 +152,6 @@ npm run test:wpt
```

<a id="lint"></a>

### Lint

```bash
Expand Down Expand Up @@ -182,6 +187,24 @@ an unbundled version instead of bundling one in `libnode.so`.
To enable this, pass `EXTERNAL_PATH=/path/to/global/node_modules/undici` to `build/wasm.js`.
You shall also pass this path to `--shared-builtin-undici/undici-path` in Node.js's `configure.py`.

<a id="benchmarks"></a>
### Benchmarks

```bash
cd benchmarks && npm i && npm run bench
```

The benchmarks will be available at `http://localhost:3042`.

<a id="documentation"></a>
### Documentation

```bash
cd docs && npm i && npm run serve
```

The documentation will be available at `http://localhost:3000`.

<a id="developers-certificate-of-origin"></a>
## Developer's Certificate of Origin 1.1

Expand Down Expand Up @@ -214,5 +237,4 @@ By making a contribution to this project, I certify that:

The [Node.js Moderation Policy] applies to this project.

[Node.js Moderation Policy]:
https://github.com/nodejs/admin/blob/main/Moderation-Policy.md
[Node.js Moderation Policy]: https://github.com/nodejs/admin/blob/main/Moderation-Policy.md