Skip to content

Commit 038e0f0

Browse files
committed
updated readme to add ci script
1 parent f8e9ff8 commit 038e0f0

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,28 @@ When creating issues or pull requests with protocol changes, generate a PDF diff
2424

2525
```bash
2626
latexdiff-vc --git --flatten --pdf -r <old-commit> LiquidCAN.tex
27-
```
27+
```
28+
29+
## Development
30+
31+
### Running CI Checks
32+
33+
The repository includes a CI script (`ci-rust.sh`) that runs all quality checks on the Rust implementation. This script is used both locally and in GitHub Actions
34+
35+
**Run all checks:**
36+
```bash
37+
./ci-rust.sh
38+
# or explicitly
39+
./ci-rust.sh all
40+
```
41+
42+
**Run individual checks:**
43+
```bash
44+
./ci-rust.sh build # Build the project
45+
./ci-rust.sh test # Run tests
46+
./ci-rust.sh test-macros # Run macro tests
47+
./ci-rust.sh fmt # Check code formatting
48+
./ci-rus/t.sh clippy # Run clippy linter
49+
./ci-rust.sh clippy-macros # Run clippy on macros
50+
```
51+
You can fix formatting or linter issues by adding the -fix suffix to the command. e.g: `./ci-rust.sh clippy-fix`

0 commit comments

Comments
 (0)