File: CONTRIBUTING.md

package info (click to toggle)
node-webassemblyjs 1.11.4%2Bdfsg%2B~cs10.11.17-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 8,328 kB
  • sloc: javascript: 29,410; makefile: 85; sh: 42; ansic: 16
file content (81 lines) | stat: -rw-r--r-- 1,063 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# Contributing

Contributions are always welcome, no matter how large or small.

## Chat

Feel free to open an issue and/or reach out @xtuc.

## Developing on the interpreter

### Setup

```sh
git clone https://github.com/xtuc/webassemblyjs
cd webassemblyjs
make bootstrap
```

### Building

```sh
make build
```

You can incrementally build the project with the following command:

```sh
make watch
```

#### With tracing

```sh
WITH_TRACE=1 make build
```

### Running linting/tests

You can run lint via:

```sh
make lint
```

You can run eslint's autofix via:

```sh
make fix
```

You can run tests via:

```sh
make test
```

You can select test based on their titles:

```sh
./scripts/test.sh --grep fsm
```

## Developing on the website

The website is located in the directory: `website` and uses [docusaurus](https://docusaurus.io).

The following commands will assume that you already are in the directory.

### Setup

```sh
yarn install
```

### Start

```sh
yarn run start
```

The website will be available at [localhost:3000](http://localhost:3000).