You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
# Contributing
|
|
|
|
|
|
## Prerequisites
|
|
|
|
|
|
The technical prerequisites for contributing to this project are the same as for
|
|
|
using it. You can find them documented [here][1].
|
|
|
|
|
|
You'll also want to check out the contributing [guidelines].
|
|
|
|
|
|
[1]: docs/prerequisites.md
|
|
|
[guidelines]: CONTRIBUTING.md
|
|
|
|
|
|
## 🏃♀️ Up and Running
|
|
|
|
|
|
1. fork and clone this repository
|
|
|
2. install [node/npm]
|
|
|
2. `cd wasm-pack`
|
|
|
3. `cargo run`. To test command line arguments you can run `cargo run -- <args>`.
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
Documentation lives in the [`/docs`](docs) directory. Each command has it's own page.
|
|
|
Additionally there are extra pages explaining the prerequisites, setup, and how to
|
|
|
contribute (which you are reading now!).
|
|
|
|
|
|
## Tests
|
|
|
|
|
|
Tests live in the [`/tests`](tests) directory. To run the tests you can run:
|
|
|
|
|
|
```
|
|
|
cargo test
|
|
|
```
|
|
|
|
|
|
You can also manually test the CLI tool by running:
|
|
|
|
|
|
```
|
|
|
cargo run -- <args>
|
|
|
```
|
|
|
|
|
|
...for example:
|
|
|
|
|
|
```
|
|
|
cargo run -- init /tests/fixtures/js-hello-world --scope=ag_dubs
|
|
|
```
|
|
|
|
