Skip to content

Commit c5ef8cb

Browse files
committed
chore(docs): update contributing guidelines
1 parent 1ea8358 commit c5ef8cb

File tree

3 files changed

+11
-3
lines changed

3 files changed

+11
-3
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ that your fix works.
2020
**3. Overcommunicate**
2121

2222
In all scenarios, please provide as much context as possible- you may not think
23-
it's important but it may be!
23+
it's important but it may be!
2424

2525
**4. Patience**
2626

2727
Axo is a very small company, it's possible that we may not be able to
28-
immediately prioritize your issue. We are excite to develop a community of
28+
immediately prioritize your issue. We are excited to develop a community of
2929
contributors around this project, but it won't always be on the top of our to-do
3030
list, even if we wish it could be.
3131

@@ -34,10 +34,15 @@ at-mention @ashleygwilliams- but please be kind while doing so!
3434

3535
## Running tests
3636

37+
Run `just dev-install` to install required binaries into your path
38+
3739
The test suite can be run with `cargo test`. [insta](https://insta.rs/docs/cli/)
3840
is used for snapshots; after running the test suite, use `cargo insta review` to
3941
review any changed snapshots.
4042

43+
The test suite specifically requires v0.7.0 of `omnibor-cli`. Other versions may
44+
not work as expected
45+
4146
The test suite cannot be run in parallel. Using an alternative test runner like
4247
`nextest` will cause unexpected behavior as tests will override each other's
4348
state.

Justfile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
dev-install:
2+
cargo binstall -y cargo-insta
3+
cargo binstall -y omnibor-cli@0.7.0
14

25
build-all-platforms:
36
#!/bin/bash -eux

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ outputs. This allows us to both catch regressions and also more easily review UI
9292
test fails, you will need to use the `cargo insta` CLI tool to update them:
9393

9494
```sh
95-
cargo install cargo-insta
95+
just dev-install
9696
```
9797

9898
Once installed, you can review and accept the changes with:

0 commit comments

Comments
 (0)