Skip to content

Commit dee8cf7

Browse files
committed
chore(words): lint using google style
1 parent f349184 commit dee8cf7

File tree

4 files changed

+27
-17
lines changed

4 files changed

+27
-17
lines changed

.vale.ini

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
MinAlertLevel = suggestion
22

3+
StylesPath = .vale.styles
4+
Packages = Google
5+
36
[*.md]
4-
BasedOnStyles = Vale
7+
BasedOnStyles = Vale, Google
58

69
Vale.Spelling = warning

CONTRIBUTING.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
1-
# Contributing to the Project
1+
# Contributing to the project
22

33
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.
55

6-
## Pre-requisite Knowledge
6+
## Pre-requisite knowledge
77

88
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.
1011
1. Familiarity with [Wasmtime](https://docs.wasmtime.dev/) as it relates to the [WebAssembly component model](https://component-model.bytecodealliance.org/).
1112

12-
## How to Develop
13+
## How to develop
1314

14-
We use [devenv](https://devenv.sh/) to manage our development environment.
15+
Use [devenv](https://devenv.sh/) to manage the development environment.
1516

1617
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`.
1920
1. `direnv allow $PWD` and/or `devenv shell` to enter the development environment.
2021
1. `devenv test` to run all the tests locally.
2122
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.
2425

2526
[License](LICENSE)
2627

27-
## Contribution Agreement
28+
## Certifying contributions
29+
30+
<!-- vale off -->
2831

2932
[Developer Certificate of Origin](https://developercertificate.org/)
3033
Version 1.1
@@ -60,3 +63,5 @@ By making a contribution to this project, I certify that:
6063
personal information I submit with it, including my sign-off) is
6164
maintained indefinitely and may be redistributed consistent with
6265
this project or the open source license(s) involved.
66+
67+
<!-- vale on -->

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
WASM Component Trampoline
2-
=========================
1+
# WebAssembly Component Trampoline
32

43
[![Crates.io](https://img.shields.io/crates/v/wasm-component-trampoline.svg)](https://crates.io/crates/wasm-component-trampoline)
54
[![Documentation](https://docs.rs/wasm-component-trampoline/badge.svg)](https://docs.rs/wasm-component-trampoline)
65
![License](https://img.shields.io/crates/l/wasm-component-trampoline.svg)
76

8-
Library for linking WASM components together using host "trampoline" functions, that can securely read/modify the host
9-
context between component calls.
7+
Library for linking WebAssembly components together using host "trampoline" functions.
8+
Trampoline functions can read and modify the provided context between inter-component calls.
9+
Guests will not directly call other components, but must go through the host trampoline functions.
1010

11-
Designed for versioned WIT (WASM Interface Type) components, but can be used with others. Versioned dependency
12-
resolution between components is done in the same style as the Wasmtime component linker
11+
Specifically designed for versioned [WIT](https://component-model.bytecodealliance.org/design/wit.html)
12+
(WASM Interface Type) packages, but users can intercept any components calls.
13+
Versioned dependency resolution occurs between components in the same style as the Wasmtime component linker
1314
([docs](https://docs.wasmtime.dev/api/wasmtime/component/struct.Linker.html#names-and-semver)).
1415

15-
![WASM Component Trampoline Example Diagram](https://raw.githubusercontent.com/andyl-technologies/wasm-component-trampoline/refs/heads/master/docs/images/example_diagram.svg)
16+
![Trampoline Example Diagram](https://raw.githubusercontent.com/andyl-technologies/wasm-component-trampoline/refs/heads/master/docs/images/example_diagram.svg)
1617

1718
## Installation
1819

devenv.nix

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
'';
5252

5353
git-hooks.hooks.actionlint.enable = true;
54+
git-hooks.hooks.check-merge-conflicts.enable = true;
5455
git-hooks.hooks.nixfmt-rfc-style.enable = true;
5556
git-hooks.hooks.vale.enable = true;
5657

0 commit comments

Comments
 (0)