Skip to content

Commit b306dd1

Browse files
committed
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]>
1 parent 8c9acca commit b306dd1

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

.claude/commands/api-review.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ You MUST use this EXACT format for ALL review feedback:
2828

2929
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.
3030

31+
I always take the latest OpenShift API conventions into account:
32+
https://github.com/openshift/enhancements/blob/master/dev-guide/api-conventions.md
33+
34+
On top of that, the code must adhere to the official Kubernetes API conventions:
35+
https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md
36+
3137
## Step 1: Pre-flight checks and determine review mode
3238

3339
First, I'll check the arguments and determine whether to review a PR or local changes:
@@ -138,6 +144,8 @@ For each changed API file, I'll validate:
138144
1. **Field Documentation**: All struct fields must have documentation comments
139145
2. **Optional Field Behavior**: Optional fields must explain what happens when they are omitted
140146
3. **Validation Documentation**: Validation rules must be documented and match markers
147+
4. **Naming Conventions**: All new fields should adhere to the OpenShift and
148+
Kubernetes naming conventions to avoid any conflicts.
141149

142150
Let me check each changed file for these requirements:
143151

@@ -194,4 +202,4 @@ fi
194202
3. MUST fetch latest changes from the detected openshift/api remote
195203
4. MUST compare against the detected remote's master branch
196204
5. MUST include both committed and staged changes in analysis
197-
6. No branch switching required since we're reviewing local changes
205+
6. No branch switching required since we're reviewing local changes

0 commit comments

Comments
 (0)