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
claude: take latest OpenShift and Kubernetes API conventions into account
It would be good if claude uses the latest conventions to do the review.
On top of that it should check for naming convention issues during the
documentation checks.
Signed-off-by: Sascha Grunert <[email protected]>
Copy file name to clipboardExpand all lines: .claude/commands/api-review.md
+16-4Lines changed: 16 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,15 @@ You MUST use this EXACT format for ALL review feedback:
28
28
29
29
I'll run a comprehensive API review for OpenShift API changes. This can review either a specific GitHub PR or local changes against upstream master.
30
30
31
+
## API Conventions
32
+
33
+
**CRITICAL**: All API changes MUST comply with both Kubernetes and OpenShift API conventions:
34
+
35
+
1.**Kubernetes API Conventions**: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md
36
+
2.**OpenShift API Conventions**: https://github.com/openshift/enhancements/blob/master/dev-guide/api-conventions.md
37
+
38
+
Before starting the review, I will fetch and review the latest API conventions from both sources to ensure all validation checks are aligned with current requirements.
39
+
31
40
## Step 1: Pre-flight checks and determine review mode
32
41
33
42
First, I'll check the arguments and determine whether to review a PR or local changes:
@@ -131,13 +140,16 @@ fi
131
140
echo"✅ Linting checks passed."
132
141
```
133
142
134
-
## Step 4: Documentation validation
143
+
## Step 4: Documentation and API conventions validation
135
144
136
145
For each changed API file, I'll validate:
137
146
138
-
1.**Field Documentation**: All struct fields must have documentation comments
139
-
2.**Optional Field Behavior**: Optional fields must explain what happens when they are omitted
140
-
3.**Validation Documentation**: Validation rules must be documented and match markers
147
+
1.**Kubernetes API Conventions**: All changes must comply with https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md
148
+
2.**OpenShift API Conventions**: All changes must comply with https://github.com/openshift/enhancements/blob/master/dev-guide/api-conventions.md
149
+
3.**Field Documentation**: All struct fields must have documentation comments
150
+
4.**Optional Field Behavior**: Optional fields must explain what happens when they are omitted
151
+
5.**Validation Documentation**: Validation rules must be documented and match markers
152
+
6.**Cross-field Validation**: Documented field relationships must have corresponding XValidation rules
141
153
142
154
Let me check each changed file for these requirements:
0 commit comments