docs(claude-md): generalize helpers-after-implementation rule - #485
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
It’s a straightforward documentation-only clarification with no behavioral or structural code impact.
Pull request overview
Updates the repository’s agent/developer guidance in CLAUDE.md to generalize the “helpers after main logic” ordering rule beyond React components, making file structure expectations consistent across components, tests, and utilities.
Changes:
- Renamed the guideline heading to cover all files (not just React components).
- Clarified the preferred ordering: primary logic first, helper functions after.
- Added rationale and a hoisting note to justify using
functiondeclarations for helpers.
File summaries
| File | Description |
|---|---|
| CLAUDE.md | Generalizes and clarifies the “implementation first, helpers after” file-structure convention for the whole codebase. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Playwright test results
Details
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Broadens the "helpers after main logic" rule from React components only to all files (components, tests, utils), explains the rationale, and adds the hoisting note — agents were defaulting to helpers-first outside
.tsxcomponents since the rule had no anchor there.No
## Verificationsection: this is a docs-only change toCLAUDE.mdwith no runtime behavior to exercise.Generated by Claude Code