Skip to content

Commit ea962de

Browse files
committed
docs: update examples
1 parent 0051719 commit ea962de

2 files changed

Lines changed: 25 additions & 13 deletions

File tree

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Code review is essential, but not all changes carry the same risk. Typo fixes, i
2828
- **Conservative by Default** - Only labels PRs with high confidence scores
2929
- **Transparent Decisions** - Adds explanatory comments to labeled PRs
3030
- **Configurable** - Customize model, threshold, label name, and more
31-
- **Four Categories** - Detects typo fixes, i18n updates, UI style changes, and code formatting
31+
- **Skip-Review Categories** - Detects typos, i18n updates, UI tweaks, formatting, unused-code cleanup, and safe dependency bumps
3232

3333
## How It Works
3434

@@ -116,7 +116,7 @@ jobs:
116116

117117
## Skip-Review Categories
118118

119-
The action identifies four types of low-risk changes:
119+
The action identifies the following low-risk change types:
120120

121121
### 1. Fix Typos
122122

@@ -154,6 +154,25 @@ Automated formatting changes from tools like Prettier or ESLint.
154154
+ const sum = a + b;
155155
```
156156

157+
### 5. Remove Unused Code
158+
159+
Cutting deprecated endpoints, feature flags, or configs that have zero remaining callers.
160+
161+
```diff
162+
-// Temporary shim until everyone hits v2
163+
-app.use('/api/v1/members', legacyMembersRouter);
164+
app.use('/api/v2/members', membersRouter);
165+
```
166+
167+
### 6. Safe Dependency Version Bump
168+
169+
Patch or minor version updates that only touch dependency manifests or lockfiles.
170+
171+
```diff
172+
- "typescript": "5.5.4"
173+
+ "typescript": "5.5.5"
174+
```
175+
157176
## Outputs
158177

159178
| Output | Description |

prompts/analysis-prompt.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -290,18 +290,11 @@ const StyledButton = styled.button`
290290

291291
```typescript
292292
// VALID - Skip review eligible
293-
- if (process.env.ENABLE_LEGACY_FLOW === 'true') {
294-
- runLegacyFlow();
295-
- }
293+
-// Temporary shim until every client calls v2
294+
-app.use('/api/v1/members', legacyMembersRouter);
295+
app.use('/api/v2/members', membersRouter);
296296

297-
- export const UNUSED_FLAG = createFeatureFlag('unused_flag');
298-
299-
- router.post('/v1/legacy-sync', legacySyncHandler);
300-
301-
- type LegacySchema = {
302-
- id: string;
303-
- deprecatedField?: string;
304-
- };
297+
-export const UNUSED_FLAG = createFeatureFlag('legacy_upgrade_banner');
305298
```
306299

307300
**Anti-patterns (NOT unused-code removals)**:

0 commit comments

Comments
 (0)