Clarify naming conventions: kebab for filesystem/URLs, camelCase for code#51
Conversation
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code review is billed via overage credits. To resume reviews, an organization admin can raise the monthly limit at claude.ai/admin-settings/claude-code.
Once credits are available, push a new commit or reopen this pull request to trigger a review.
📝 WalkthroughWalkthroughUpdated the "Development Guidelines" section in README.md to refine naming conventions: code identifiers are now explicitly camelCase by default with language-specific exceptions, filesystem and URL strings use kebab-case, and folder naming changed from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 6: Update the "Code identifiers" guidance to remove the conflicting
PascalCase instruction and explicitly state that for PowerShell (*.ps1) both
variables and functions should use camelCase; edit the line that currently reads
"PowerShell uses PascalCase for functions and camelCase for variables" to a
single clear rule (e.g., "PowerShell: use camelCase for functions and
variables") and update the example to reflect a camelCase function name so the
README and repo convention match.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| - We develop in camelCase only unless otherwise specified by the language itself. E.G. Python we use snake_case. | ||
| - We label folders as "category"-"vendor/app" | ||
| - Each script, unless specified, should support both interactive input and RMM input. | ||
| - **Code identifiers** (variables, functions, parameters): camelCase by default unless the language specifies otherwise. E.g. PowerShell uses PascalCase for functions and camelCase for variables; Python uses snake_case. |
There was a problem hiding this comment.
Resolve conflicting PowerShell function naming guidance
Line 6 says PowerShell functions should be PascalCase, but existing repo guidance says PowerShell variables and functions should be camelCase. Please align these to a single standard to avoid contradictory review outcomes and script naming drift. Based on learnings: "Applies to **/*.ps1 : Use camelCase for PowerShell variables and functions".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 6, Update the "Code identifiers" guidance to remove the
conflicting PascalCase instruction and explicitly state that for PowerShell
(*.ps1) both variables and functions should use camelCase; edit the line that
currently reads "PowerShell uses PascalCase for functions and camelCase for
variables" to a single clear rule (e.g., "PowerShell: use camelCase for
functions and variables") and update the example to reflect a camelCase function
name so the README and repo convention match.
Gumbees
left a comment
Gumbees
left a comment
There was a problem hiding this comment.
Summary
README docs update splitting naming guidance into two axes ... camelCase for code identifiers, kebab-case for filesystem/URLs ... documenting the convention that already exists in folder names like bdr-veeam and sec-huntress.
What works
- Codifies the convention that the repo has been following organically since the start. The previous wording ("we develop in camelCase only") was misleading.
- Calls out the language-specific exceptions (PowerShell PascalCase functions, Python snake_case) ... matches what's already in CLAUDE.md.
- Explicitly covers log filenames and slugs, not just script names. That's the bit that was ambiguous before.
Concerns
None.
Suggestions
- CLAUDE.md (lines 98-103) has overlapping naming guidance. Worth a one-line cross-reference or sync sweep to make sure README and CLAUDE.md agree once this lands.
Verdict
APPROVE ... clean docs update, zero behavioral risk, fixes a real ambiguity.
…code The original "camelCase only" guideline conflated code identifiers with filesystem paths. Kebab-case has been the actual convention for folders (app-adobe, bdr-veeam, etc.) and is the right choice for filenames, log names, and URLs as well — shell-friendly, URL-safe, and forces a clean split between path/slug semantics and code-identifier semantics. Code identifiers continue to follow language convention (camelCase for variables, PascalCase for PowerShell functions, snake_case for Python).
Gumbees
force-pushed
the
enhancement/clarify-naming-conventions
branch
from
50d1c40 to
97d1e5c
Compare
There was a problem hiding this comment.
Code review is billed via overage credits. To resume reviews, an organization admin can raise the monthly limit at claude.ai/admin-settings/claude-code.
Once credits are available, push a new commit or reopen this pull request to trigger a review.
1 participant
Summary
Splits the README's naming guidance into two clear axes that were previously conflated:
Why
The original wording "We develop in camelCase only" was applied across the board, but kebab-case has actually been the convention for folders (
app-adobe,bdr-veeam,iaas-azure, etc.) since the repo started, and we want kebab-case for new filenames and log names too. Kebab-case is shell-friendly (no quoting), URL-safe (RFC 3986 unreserved), and forces a clean split between "this is a path/slug" vs "this is a code identifier."This came up while reviewing PR #31 — I initially flagged a kebab-case log filename as a "violation" against the README, then realized the README itself was the misalignment.
Test plan
Notes
CLAUDE.mdthis kind of doc update would normally be eligible for direct-to-main, but branch protection requires PR — fine, going through the regular flow.Summary by CodeRabbit