|
2 | 2 |
|
3 | 3 | ## Development Guidelines |
4 | 4 |
|
5 | | -- project is a monorepo Rust workspace, java bindings in `/java`, python bindings in |
| 5 | +- Project is a monorepo Rust workspace, java bindings in `/java`, python bindings in |
6 | 6 | `/vortex-python` |
7 | | -- run `cargo build -p` to build a specific crate |
8 | | -- use `cargo clippy --all-targets --all-features` to make sure a project is free of lint issues. |
| 7 | +- Run `cargo build -p` to build a specific crate |
| 8 | +- Use `cargo clippy --all-targets --all-features` to make sure a project is free of lint issues. |
9 | 9 | Please do this every time you reach a stopping point or think you've finished work. |
10 | | -- run `cargo +nightly fmt --all` to format Rust source files. Please do this every time you reach a |
| 10 | +- Run `cargo +nightly fmt --all` to format Rust source files. Please do this every time you reach a |
11 | 11 | stopping point or think you've finished work. |
12 | | -- run `./scripts/public-api.sh` to re-generate the public API lock files. Please do this every time |
| 12 | +- Run `./scripts/public-api.sh` to re-generate the public API lock files. Please do this every time |
13 | 13 | you reach a stopping point or think you've finished work. |
14 | | -- you can try running |
| 14 | +- You can try running |
15 | 15 | `cargo fix --lib --allow-dirty --allow-staged && cargo clippy --fix --lib --allow-dirty --allow-staged` |
16 | 16 | to automatically many fix minor errors. |
17 | | -- when iterating on CI failures, fetch only failed job logs first |
| 17 | +- When iterating on CI failures, fetch only failed job logs first |
18 | 18 | (`gh run view <run-id> --job <job-id> --log-failed`) and run narrow local repro commands for the |
19 | 19 | affected crate/tests before running workspace-wide checks. |
20 | | -- if `gh` commands fail with `error connecting to api.github.com` in sandbox, immediately rerun with |
| 20 | +- If `gh` commands fail with `error connecting to api.github.com` in sandbox, immediately rerun with |
21 | 21 | escalated network permissions instead of retrying in sandbox. |
22 | | -- if cargo fails with `sccache: error: Operation not permitted`, rerun the command with |
23 | | - `RUSTC_WRAPPER=` so rustc runs directly. |
24 | | -- run docs doctests from the docs directory (`make -C docs doctest`) so the correct Sphinx Makefile |
| 22 | +- If cargo fails with `sccache: error: Operation not permitted`, rerun the command with |
| 23 | + `RUSTC_WRAPPER=` so rustc runs directly. You should ONLY do this if you get this exact error, as |
| 24 | + this is only a concern when you are running on our CI. |
| 25 | +- Run docs doctests from the docs directory (`make -C docs doctest`) so the correct Sphinx Makefile |
25 | 26 | target is used. |
26 | 27 |
|
27 | 28 | ## Architecture |
|
0 commit comments