Skip to content

Commit 9d98c38

Browse files
committed
README - Adoption
1 parent d4180a0 commit 9d98c38

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,23 @@ Options:
2828
Print version
2929
```
3030

31+
### Adoption
32+
This is an experimental tool and not currently supported by Gusto engineering foundational teams. It might stop working at any time. If you still wish to adopt it locally and get faster git commit hooks, do the following:
33+
```bash
34+
# sets up a Rust toolchain
35+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
36+
37+
# Compile and install locall
38+
gh repo clone rubyatscale/codeowners-rs
39+
cd codeowners-rs
40+
cargo install --path .
41+
42+
# Set an environment variable that switches ZP's commit hook to use the globally installed binary
43+
echo USE_CODEOWNERS_RS=true >> ~/.zshrc
44+
```
45+
46+
47+
3148
### Development
3249
The CLI is written in Rust. Rust provides strong type gurantees and an great ecosystem of CLI libraries. To be able to compile the code locally, you'll need to setup a rust compiler (See https://rustup.rs/):
3350

0 commit comments

Comments
 (0)