Skip to content

Commit 28eb00c

Browse files
authored
docs(README): add testing and formatting instructions for Q CLI crate (#1000)
1 parent 9dc5739 commit 28eb00c

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,12 +156,26 @@ pnpm install --ignore-scripts
156156
### 3. Start Local Development
157157
To compile and view changes made to `q chat`:
158158
```shell
159-
alias run_q_chat='cargo run --bin q_cli -- chat'
160-
run_q_chat
159+
cargo run --bin q_cli -- chat
161160
```
162161

163162
> If you are working on other q commands, just replace `chat` with the command name
164163
164+
To run tests for the Q CLI crate:
165+
```shell
166+
cargo test -p q_cli
167+
```
168+
169+
To format Rust files:
170+
```shell
171+
cargo +nightly fmt
172+
```
173+
174+
To run clippy:
175+
```shell
176+
cargo clippy --locked --workspace --color always -- -D warnings
177+
```
178+
165179

166180

167181
### 💡 Quick Tip for Onboarding

0 commit comments

Comments
 (0)