File: cpp-review.instructions.md

package info (click to toggle)
conky 1.22.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 10,376 kB
  • sloc: cpp: 64,271; ansic: 18,382; python: 813; xml: 324; sh: 248; makefile: 143; javascript: 139
file content (23 lines) | stat: -rw-r--r-- 1,436 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
---
applyTo: 'src/**/*.cc,src/**/*.hh,src/**/*.hpp,src/**/*.h,src/**/*.cpp,tests/**/*.cc,tests/**/*.hh,tests/**/*.hpp,tests/**/*.h,lua/**/*.cc,lua/**/*.hh,lua/**/*.hpp,lua/**/*.h'
excludeAgent: 'coding-agent'
---

# Conky C/C++ Review Instructions

Prioritize behavioral correctness, regressions, and runtime safety over style-only feedback.

Focus review comments on:

- Changes to text object registration (for example `OBJ`, `OBJ_ARG`, `OBJ_IF`, and `OBJ_IF_ARG` in `construct_text_object()` in `src/core.cc`) and update logic (`update_cb` + `conky::callback_handle`) that could break refresh cadence, caching, or responsiveness.
- Backend behavior across output modes (`display_output_base` descendants), especially graceful degradation for ncurses and HTTP outputs.
- Platform-guarded logic under `src/data/os/` and tests that should mirror implementation `#ifdef` boundaries.
- Lifetime/ownership bugs, null dereferences, unchecked conversions, out-of-bounds access, and unintended copies in hot paths.

Testing expectations:

- New behavior should have or update tests in `tests/test-*.cc`.
- Encourage focused test runs with `./build/tests/test-conky "<test-or-tag>"` and full verification with `ctest --test-dir build --output-on-failure`.
- If behavior changed but no test changed, ask for justification.

Do not request purely stylistic changes already enforced by clang-format unless readability or correctness is impacted.