feat(skills): add style review workflow

This commit is contained in:
2026-09-17 09:56:58 -04:00
parent 247712582a
commit cf9a671fb8
15 changed files with 160 additions and 66 deletions

View File

@@ -0,0 +1,9 @@
---
name: rust-style
description: Use when creating, editing, or reviewing Rust files in this repository.
---
# rust-style
Use this skill as the source of truth for repository Rust conventions.
Follow the shared style skill instructions in `src/skills/style/STYLE.md`.

View File

@@ -0,0 +1,39 @@
# Build rules
## Use workspace dependency versions
### Rule
Declare Rust dependency versions in the repository root `Cargo.toml` under `[workspace.dependencies]`.
Reference workspace dependencies from package `Cargo.toml` files with `workspace = true`.
Do not declare dependency versions in package `Cargo.toml` files unless the operator explicitly requests a package-local version.
Add package-local dependency features only when the feature set is specific to that package.
### Rationale
The repository has one Cargo workspace and one `Cargo.lock`.
Centralized dependency versions keep package manifests consistent with the workspace lockfile.
## Declare Rust tests in Bazel
### Rule
Declare Rust test files in the nearest Bazel `BUILD` file with `rust_test`.
Do not add `[[test]]` entries to `Cargo.toml` unless the operator explicitly requests Cargo test declarations.
### Rationale
Bazel is the source of truth for Rust test targets in this repository.
Keeping test declarations in Bazel avoids duplicate test target lists.
## Use one source input style per `rust_test`
### Rule
Do not set both `crate` and `srcs` on a `rust_test` target.
Use exactly one input style for each Rust test target.
### Rationale
`rules_rust` rejects `rust_test` targets that set both `crate` and `srcs`.
Keeping one input style per target makes the test declaration valid and unambiguous.

View File

@@ -0,0 +1,28 @@
# File rules
## Avoid generic Rust file names
### Rule
Do not name Rust source files `lib.rs` or `main.rs`.
Name library crate root files after the crate they define.
Name binary crate root files after the binary they define, or use a `_main.rs` suffix.
Set explicit Cargo paths and Bazel `srcs` when needed.
### Rationale
Generic root names make file search results and review context less clear.
Descriptive file names show which crate or binary owns the code.
## Keep Rust tests in separate files
### Rule
Put Rust tests in separate `*_test.rs` files.
Name each test file after the Rust source file or crate root that it tests.
Do not use generic test file names such as `lib_test.rs` or `main_test.rs`.
Do not add inline `#[cfg(test)]` modules.
### Rationale
Separate test files keep production modules focused and match the repository's Bazel test layout.