Skip to content

Commit 0c66d0d

Browse files
authored
Add CONTRIBUTING.md (WebAssembly#26)
It is not especially clear how to update the WIT ABI file, so this new document describes the current steps to do so.
1 parent d9d0398 commit 0c66d0d

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing
2+
3+
Thank you for contributing to this specification. This repository follows the
4+
same guidelines as the [WASI contribution guidelines].
5+
6+
[WASI contribution guidelines]: https://github.com/WebAssembly/WASI/blob/main/Contributing.md
7+
8+
The specification is written in WIT (WebAssembly Interface Types) syntax in code
9+
blocks inside a Markdown file (`wasi-nn.wit.md`). This is parseable by WIT tools
10+
(e.g., [`wit-bindgen`], [`wit-abi`]). Note that, when altering the WIT
11+
specification, the ABI file (`wasi-nn.abi.md`) must also be updated or CI will
12+
fail. To use [`wit-abi`] to update the ABI file, run:
13+
14+
[`wit-bindgen`]: https://github.com/bytecodealliance/wit-bindgen
15+
[`wit-abi`]: https://github.com/WebAssembly/wasi-tools/tree/main/wit-abi
16+
17+
```console
18+
$ git clone https://github.com/WebAssembly/wasi-tools
19+
$ cd wasi-tools/wit-abi
20+
$ cargo build
21+
$ target/debug/wit-abi <path to wasi-nn directory>
22+
```

0 commit comments

Comments
 (0)