summaryrefslogtreecommitdiffstats
path: root/src/fluent-bit/lib/wasm-micro-runtime-WAMR-1.2.2/test-tools/wamr-ide/VSCode-Extension/CONTRIBUTING.md
blob: f70a959ebc7a368ec6a03fe8a13a70ea44466bb3 (plain)
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
# CONTRIBUTING

## Pull requests

To submit your change:

-   Make sure your code is in line with our
    [coding conventions](##Coding-conventions).
-   Create an [issue] describing the bug the PR fixes or the feature you intend
    to implement.
-   Submit a [pull request] into the main branch.

## Coding conventions

#### Format

The codebase is formatted by `Prettier` and the `.prettierrc.json` has been
configured.

-   VSCode along with `Format on Save` configuration could easily format your
    code during development.
-   You can run `prettier-format-check` and `prettier-format-apply` to check and
    format your codebase with `prettier` in terminal.

#### Lint

`ESlint` is used as linter for the codebase and the `.eslintrc.json` has been
configured.

-   It's suggested to run `npm run lint` then fix errors and warnings before
    committing.

[issue]: https://github.com/bytecodealliance/wasm-micro-runtime/issues
[pull request]: https://github.com/bytecodealliance/wasm-micro-runtime/pulls