Skip to content

Commit 6ae393a

Browse files
committed
chore(oss): scaffold contributions
1 parent f9c8fe9 commit 6ae393a

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

CONTRIBUTING.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Contributing to the Project
2+
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.
5+
6+
## Pre-requisite Knowledge
7+
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).
10+
1. Familiarity with [Wasmtime](https://docs.wasmtime.dev/) as it relates to the [WebAssembly component model](https://component-model.bytecodealliance.org/).
11+
12+
## How to Develop
13+
14+
We use [devenv](https://devenv.sh/) to manage our development environment.
15+
16+
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.
19+
1. `direnv allow $PWD` and/or `devenv shell` to enter the development environment.
20+
1. `devenv test` to run all the tests locally.
21+
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.
22+
23+
## License
24+
25+
[License](LICENSE)
26+
27+
## Contribution Agreement
28+
29+
[Developer Certificate of Origin](https://developercertificate.org/)
30+
Version 1.1
31+
32+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
33+
34+
Everyone is permitted to copy and distribute verbatim copies of this
35+
license document, but changing it is not allowed.
36+
37+
38+
Developer's Certificate of Origin 1.1
39+
40+
By making a contribution to this project, I certify that:
41+
42+
(a) The contribution was created in whole or in part by me and I
43+
have the right to submit it under the open source license
44+
indicated in the file; or
45+
46+
(b) The contribution is based upon previous work that, to the best
47+
of my knowledge, is covered under an appropriate open source
48+
license and I have the right under that license to submit that
49+
work with modifications, whether created in whole or in part
50+
by me, under the same open source license (unless I am
51+
permitted to submit under a different license), as indicated
52+
in the file; or
53+
54+
(c) The contribution was provided directly to me by some other
55+
person who certified (a), (b) or (c) and I have not modified
56+
it.
57+
58+
(d) I understand and agree that this project and the contribution
59+
are public and that a record of the contribution (including all
60+
personal information I submit with it, including my sign-off) is
61+
maintained indefinitely and may be redistributed consistent with
62+
this project or the open source license(s) involved.

0 commit comments

Comments
 (0)