You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/skills/cpp_coding.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,3 +31,10 @@ Use this protocol to ensure all C++ code modifications align with the project's
31
31
### 6. Performance Checks
32
32
***Hot Paths**: Check for hidden allocations in loops or streaming callbacks.
33
33
***Copying**: Minimize data copying; use const references (`const T&`) for non-primitive arguments.
34
+
35
+
### 7. Comments
36
+
***Comments should be sparse.** Keep to 1–2 lines unless the code is large and genuinely complex.
37
+
***Intention:** Don't restate what the code already says, comment should convey the reason for the code.
38
+
***Locality:** The comment should refer to the local code. e.g. class description should not mention inheritors or where other logic live.
39
+
***Length:** Comment lines can be as long as the surrounding code. If code lines usually trim at 120 characters comment lines don't have to be 80 characters long.
40
+
***Generality:** Don't reference internal session reasoning e.g. "as you instructed"
**Test name derivation**: the orchestrator builds a test's name from its path relative to `unit-tests/`, replacing directory separators with `-` and stripping the leading `test-` from the filename. For example:
Weekly tests use a higher iteration count / longer timeout (controlled by `'weekly' in test.context` inside the test). The `--context` flag accepts a **space-separated list**, so to run a nightly-guarded test with weekly behaviour pass **both** contexts:
170
+
A test that also scales its iteration count or timeout for weekly runs reads the context through the
171
+
`test_context_var` fixture, so pass both words to get nightly collection plus weekly behaviour:
150
172
151
173
```bash
152
-
# 'nightly' satisfies the test:donotrun:!nightly guard
153
-
# 'weekly' activates higher iteration counts and longer timeouts inside the test
The SDK no longer ships a bundled firmware blob, so `test-fw-update`**requires** a custom firmware path for the device under test. Without one it logs a warning and skips. Download a signed `.bin` from <https://dev.realsenseai.com/docs/firmware-updates>, then:
223
+
The SDK no longer ships a bundled firmware blob, so `pytest-fw-update`**requires** a custom firmware path for the device under test. Without one it skips. Download a signed `.bin` from <https://dev.realsenseai.com/docs/firmware-updates>, then:
0 commit comments