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
## [CONSISTENCY-17] No AI-generated jargon in code or comments
7
+
8
+
### Reasoning
9
+
10
+
Certain phrases appear constantly in AI-generated code but rarely in code written by engineers. They make the codebase sound like it was written by a chatbot and should be replaced with plain, direct language.
11
+
12
+
### Banned phrases
13
+
14
+
| Phrase | Plain substitute |
15
+
|--------|-----------------|
16
+
| sentinel | placeholder, marker, guard entry |
17
+
| fan out | send, make, dispatch, distribute |
18
+
| carve out | set aside, exclude, separate |
19
+
| defense in depth | extra guard, additional check |
20
+
| belt and suspenders / belt-and-suspenders | extra safety check, redundant guard |
21
+
| fresh evidence | new data, updated result |
22
+
23
+
### Incorrect
24
+
25
+
```ts
26
+
// Fan out the request to every matching snapshot.
27
+
function getSentinelValue() { ... }
28
+
const fanOutRequests = () => { ... }
29
+
30
+
// Defense in depth: reject the value if it arrived stale.
31
+
// Belt-and-suspenders check before writing.
32
+
// Uses a sentinel to signal end-of-stream.
33
+
```
34
+
35
+
### Correct
36
+
37
+
```ts
38
+
// Send the request to every matching snapshot.
39
+
function getPlaceholderValue() { ... }
40
+
const sendDuplicateRequests = () => { ... }
41
+
42
+
// Additional guard: reject the value if it arrived stale.
43
+
// Extra safety check before writing.
44
+
// Uses a placeholder to signal end-of-stream.
45
+
```
46
+
47
+
---
48
+
49
+
### Review Metadata
50
+
51
+
Flag when any added or modified code — including comments, function names, variable names, type names, or string literals — contains one of the banned phrases above.
52
+
53
+
**DO NOT flag if:**
54
+
55
+
- The phrase appears inside a quoted external API name, a third-party library identifier, or a value the codebase does not control (e.g. a server response field name)
56
+
- The phrase is in a test description string that is directly testing behavior described by an external spec or API that uses the term
0 commit comments