You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,22 @@
1
-
# Contributing to the Project
1
+
# Contributing to the project
2
2
3
3
Thank you for your interest in contributing to wasm-component-trampoline.
4
-
We welcome contributions from the community and appreciate your efforts to improve the codebase.
4
+
We welcome community contributions and appreciate your efforts to improve the codebase.
5
5
6
-
## Pre-requisite Knowledge
6
+
## Pre-requisite knowledge
7
7
8
8
Before you start contributing, please ensure you have the following:
9
-
1. A working knowledge of Rust and [WebAssembly](https://webassembly.org/) (or a willingness to learn).
9
+
10
+
1. A working knowledge of [Rust](https://www.rust-lang.org/) and [WebAssembly](https://webassembly.org/) or a willingness to learn.
10
11
1. Familiarity with [Wasmtime](https://docs.wasmtime.dev/) as it relates to the [WebAssembly component model](https://component-model.bytecodealliance.org/).
11
12
12
-
## How to Develop
13
+
## How to develop
13
14
14
-
We use [devenv](https://devenv.sh/) to manage our development environment.
15
+
Use [devenv](https://devenv.sh/) to manage the development environment.
15
16
16
17
1.**Clone the Repository**: You know how to do that.
17
-
1.**Install direnv**: Follow the instructions at [direnv Installation](https://direnv.net/docs/installation.html) to install direnv.
18
-
1.**Install Devenv**: Follow the instructions at [Devenv Installation](https://devenv.sh/docs/installation) to install devenv.
18
+
1.**Install direnv**: Follow the instructions at [direnv Installation](https://direnv.net/docs/installation.html) to install `direnv`.
19
+
1.**Install Devenv**: Follow the instructions at [devenv Installation](https://devenv.sh/docs/installation) to install `devenv`.
19
20
1.`direnv allow $PWD` and/or `devenv shell` to enter the development environment.
20
21
1.`devenv test` to run all the tests locally.
21
22
1. (OPTIONAL) `devenv shell wasm-trampoline-coverage` to generate code coverage. `cargo llvm-cov report --html --open --release` to view a coverage report in your browser.
@@ -24,7 +25,9 @@ We use [devenv](https://devenv.sh/) to manage our development environment.
24
25
25
26
[License](LICENSE)
26
27
27
-
## Contribution Agreement
28
+
## Certifying contributions
29
+
30
+
<!-- vale off -->
28
31
29
32
[Developer Certificate of Origin](https://developercertificate.org/)
30
33
Version 1.1
@@ -60,3 +63,5 @@ By making a contribution to this project, I certify that:
60
63
personal information I submit with it, including my sign-off) is
61
64
maintained indefinitely and may be redistributed consistent with
62
65
this project or the open source license(s) involved.

16
+

0 commit comments