derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
54 lines
2.6 KiB
Markdown
54 lines
2.6 KiB
Markdown
---
|
|
name: rdc-review-style
|
|
description: "Style review subagent. Checks formatting, naming conventions, pre-commit compliance for RDC. Use when: style review, formatting check, naming conventions."
|
|
tools: execute/runInTerminal, read/readFile, search/textSearch, search/fileSearch, search/listDirectory
|
|
model: claude-sonnet-4-6
|
|
user-invocable: false
|
|
---
|
|
|
|
# Style Review — RDC
|
|
|
|
You review formatting, naming conventions, and pre-commit compliance for the RDC project.
|
|
|
|
## Formatting & Style
|
|
|
|
The project uses **pre-commit** hooks. Style violations are **❌ BLOCKING** — they will fail CI.
|
|
|
|
| Language | Tool | Config |
|
|
|----------|------|--------|
|
|
| C/C++ | **clang-format** | `.clang-format` (check root for config; Google-adjacent style) |
|
|
| Python | **black** / **Ruff** | `pyproject.toml` (check for configured line length and rules) |
|
|
| CMake | **gersemi** | `.gersemirc` (4-space indent, 120 col) |
|
|
| Proto | Proto style | Message names PascalCase, field names snake_case, service names PascalCase |
|
|
|
|
Additional hooks: `trailing-whitespace`, `end-of-file-fixer`, `check-yaml`, `check-added-large-files`.
|
|
|
|
## Naming Conventions
|
|
|
|
| Scope | Convention |
|
|
|-------|-----------|
|
|
| **C Public API** | `rdc_<verb>_<noun>()`, returns `rdc_status_t`. Enums: `rdc_<name>_t`. Handles: `rdc_handle_t`, `rdc_gpu_group_t`, `rdc_field_grp_t`. Constants: `RDC_<NAME>` |
|
|
| **C++ Internal** | PascalCase class names with `Rdc` prefix (`RdcEmbeddedHandler`, `RdcCacheManagerImpl`). Interface suffixes: `Impl` for concrete, no suffix for abstract. Methods: `camelCase` |
|
|
| **gRPC Proto** | Service names: PascalCase (`RdcAPI`, `RdcAdmin`). RPC names: PascalCase. Message names: PascalCase. Field names: `snake_case`. Enum values: `UPPER_SNAKE_CASE` |
|
|
| **Python** | `snake_case` functions and variables. `PascalCase` classes. See project `pyproject.toml` for lint rules |
|
|
| **CMake** | Functions: `snake_case`. Variables: `UPPER_CASE`. Commands: lowercase |
|
|
| **Field IDs** | `RDC_FI_<SUBSYSTEM>_<NOUN>` (e.g., `RDC_FI_GPU_UTIL`, `RDC_FI_POWER_USAGE`) |
|
|
| **Commits** | Prefer `[RDC]`, `[SWDEV-XXXXXX]`, or `[ROCM-XXXXXX]` prefix tags |
|
|
|
|
## Severity
|
|
|
|
| Marker | Use for |
|
|
|--------|---------|
|
|
| **❌ BLOCKING** | Style violations against configured formatters, naming convention breaks in public API |
|
|
| **⚠️ IMPORTANT** | Poor naming that hurts readability, missing consistency in internal code |
|
|
| **💡 SUGGESTION** | Minor style preferences, alternative naming |
|
|
| **📋 FUTURE WORK** | Unrelated style improvements in untouched code |
|
|
|
|
## Output
|
|
|
|
Return findings as a markdown list:
|
|
|
|
**[F-N] [Severity]: [Issue Title]** (`file:line`)
|
|
- Explanation and impact
|
|
- **Fix:** [fix] or **Option A/B** with recommendation
|