Skip to content

Commit e5811d5

Browse files
Add minimum contribution guide
1 parent 40bdb77 commit e5811d5

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
1+
# How to Contribute
2+
3+
Thank you for your interest in contributing to ruby.wasm!
4+
This document describes development setup and pointers for diving into this project.
5+
6+
## Install dependencies
7+
8+
```console
9+
$ git clone https://github.com/ruby/ruby.wasm
10+
$ cd ruby.wasm
11+
$ bundle install
12+
$ rake --tasks
13+
```
14+
15+
## Building and Testing [`ruby-wasm-wasi`](./packages/ruby-wasm-wasi)
16+
17+
```console
18+
# Download a prebuilt Ruby release (if you don't need to re-build Ruby)
19+
$ rake build:download_prebuilt
20+
# Build npm package
21+
$ rake npm:ruby-head-wasm-wasi
22+
# Test npm package
23+
$ rake npm:ruby-head-wasm-wasi-check
24+
```
25+
126
## Re-bindgen from `.wit` files
227

328
If you update [`*.wit`](https://github.com/WebAssembly/component-model/blob/ed90add27ae845b2e2b9d7db38a966d9f78aa4c0/design/mvp/WIT.md), which describe the interface of a WebAssembly module, either imported or exported, you need to re-generate glue code from `*.wit`.

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,3 +129,8 @@ $ ls packages/npm-packages/ruby-head-wasm-wasi/ruby-head-wasm-wasi-*.tgz
129129
The current WASI target build does not yet support `Thread` related APIs. Specifically, WASI does not yet have an API for creating and managing threads yet.
130130

131131
Also there is no support for networking. It is one of the goal of WASI to support networking in the future, but it is not yet implemented.
132+
133+
134+
## Contributing
135+
136+
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/ruby.wasm

0 commit comments

Comments
 (0)