NO-JIRA: Add Claude Code command /check-best-practices #15616
+157
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@krishagarwal278: This pull request explicitly references no jira issue. In response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: krishagarwal278 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/retest |
3 similar comments
|
/retest |
|
/retest |
|
/retest |
|
/label docs-approved |
a5909f0 to
b7344d6
Compare
|
/retest |
4df651c to
e778905
Compare
e778905 to
4e93329
Compare
logonoff
reviewed
Oct 24, 2025
| ### Additional OpenShift Console Specific Practices | ||
|
|
||
| **React Component Patterns**: | ||
| - Use `React.FCC` instead of `React.FC` for components (fixes legacy dependency issues) |
There was a problem hiding this comment.
Suggested change
| - Use `React.FCC` instead of `React.FC` for components (fixes legacy dependency issues) | |
| - Use `React.FCC` instead of `React.FC` for components (fixes an issue with implicit `children` in `React.FC` provided by React 17, our current React version) |
|
|
||
| ### Additional OpenShift Console Specific Practices | ||
|
|
||
| **React Component Patterns**: |
There was a problem hiding this comment.
Suggested change
| **React Component Patterns**: | |
| ### React Component Patterns |
| **React Component Patterns**: | ||
| - Use `React.FCC` instead of `React.FC` for components (fixes legacy dependency issues) | ||
|
|
||
| **Type Safety & Kubernetes Integration**: |
There was a problem hiding this comment.
Suggested change
| **Type Safety & Kubernetes Integration**: | |
| ### Type Safety & Kubernetes Integration |
| - Use optional chaining for safe property access | ||
| - Initialize with proper defaults instead of repeated null checks | ||
|
|
||
| **Code Organization**: |
There was a problem hiding this comment.
Suggested change
| **Code Organization**: | |
| ### Code Organization |
| - Never use absolute paths in code. The app should be able to run behind a proxy under an arbitrary path. | ||
| - TESTS: Should follow a similar "test tables" convention as used in Go where applicable. | ||
|
|
||
| ### Additional OpenShift Console Specific Practices |
There was a problem hiding this comment.
maybe we can integrate this better into the styleguide?
Comment on lines
+16
to
+72
| ### Directory and File Names | ||
| - ✅ **Use lowercase dash-separated names for all files** (avoids git issues with case-insensitive file systems) | ||
| - ✅ **Exceptions only for conventional files** (Dockerfile, Makefile, README) | ||
|
|
||
| ### Go Best Practices | ||
| - ✅ **All Go code should be formatted by gofmt** | ||
| - ✅ **Import statements should be separated into 3 groups**: stdlib, external dependency, current project | ||
| - ✅ **Tests should follow "test tables" convention** | ||
|
|
||
| ### TypeScript and JavaScript Best Practices | ||
| - ✅ **New code should be written in TypeScript, not JavaScript** | ||
| - ✅ **Prefer functional components to class-based components** | ||
| - ✅ **Use React hooks with functional components if you need state** | ||
| - ✅ **Prefer composition to inheritance** | ||
| - ✅ **Follow all rules defined in .eslintrc** | ||
| - ✅ **Never use absolute paths in code** - app should run behind a proxy under arbitrary path | ||
| - ✅ **Tests should follow "test tables" convention** (similar to Go) | ||
|
|
||
| ### SCSS/CSS Best Practices | ||
| - ✅ **All SCSS files imported from top-level** `/frontend/public/style.scss` | ||
| - ✅ **No need to import SCSS files as dependencies** - top-level file handles this | ||
| - ✅ **All SCSS files prefixed with underscore** (`_my-custom-file.scss`) | ||
| - ✅ **Avoid element selectors, prefer class selectors** | ||
| - ✅ **Scope all classes with `co-` prefix** to avoid collisions with imported CSS | ||
| - ✅ **Class names lowercase and dash-separated** | ||
| - ✅ **All SCSS variables scoped within their component** | ||
| - ✅ **Use BEM naming conventions** | ||
|
|
||
| ### Additional OpenShift Console Specific Practices | ||
|
|
||
| **React Component Patterns**: | ||
| - Use `React.FCC` instead of `React.FC` for components (fixes legacy dependency issues) | ||
| - Prefer functional components with hooks over class components | ||
| - Use composition over inheritance patterns | ||
|
|
||
| **Type Safety & Kubernetes Integration**: | ||
| - Use specific Kubernetes resource types instead of generic `K8sResourceCommon` when possible | ||
| - Avoid excessive use of `any` types | ||
| - Avoid type assertions with `as any` | ||
| - Use optional chaining for safe property access | ||
| - Initialize with proper defaults instead of repeated null checks | ||
|
|
||
| **Code Organization**: | ||
| - Follow established directory structure patterns | ||
| - Use consistent import organization | ||
| - Maintain clear separation of concerns | ||
|
|
||
| ### Analysis Process | ||
|
|
||
| 1. **File Structure**: Check file naming and organization | ||
| 2. **Go Code Quality**: Verify gofmt formatting and import grouping | ||
| 3. **TypeScript Usage**: Verify modern TypeScript patterns | ||
| 4. **React Patterns**: Assess component structure and hooks usage | ||
| 5. **SCSS/CSS Patterns**: Check BEM naming, prefixing, and organization | ||
| 6. **Style Guide Compliance**: Check against official OpenShift Console style guide | ||
| 7. **Code Quality**: Evaluate maintainability and consistency | ||
| 8. **OpenShift Specific**: Review Kubernetes integration patterns |
There was a problem hiding this comment.
if this stuff is in the styleguide, do we need to deduplicate it for claude?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.