Skip to content

docs(skills): add multi-entity naming and config-driven enum rules#3254

Merged
PierreBrisorgueil merged 3 commits into
masterfrom
chore/update-skills-naming-conventions
Mar 16, 2026
Merged

docs(skills): add multi-entity naming and config-driven enum rules#3254
PierreBrisorgueil merged 3 commits into
masterfrom
chore/update-skills-naming-conventions

Conversation

@PierreBrisorgueil

@PierreBrisorgueil PierreBrisorgueil commented Mar 16, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add multi-entity module naming convention to /naming skill (files must be prefixed by module name, not entity name)
  • Add config-driven enum guidance to /create-module skill (business values must come from module config, not hardcoded)

Test plan

  • Lint passes (0 errors)
  • All 159 unit tests pass
  • Verify skills render correctly in Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated module creation guidance documentation with clarified heading structure and improved reference paths.
    • Enhanced naming convention documentation with additional module mapping examples.

@PierreBrisorgueil PierreBrisorgueil added the Docs Documentation only changes label Mar 16, 2026
Copilot AI review requested due to automatic review settings March 16, 2026 08:46

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates internal Claude skills documentation to clarify naming for multi-entity modules and to encourage config-driven enums when scaffolding new modules.

Changes:

  • Document multi-entity module file naming (module-prefixed filenames even when modeling multiple entities).
  • Add guidance to /create-module on defining enum-like business values in module config and referencing them from models/schemas.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
.claude/skills/naming/SKILL.md Adds “multi-entity modules” naming guidance and a generalized {module}.{entity}... pattern.
.claude/skills/create-module/SKILL.md Adds a “config-driven enums” subsection describing where to define and how to reference business enums.

Comment thread .claude/skills/naming/SKILL.md
Comment thread .claude/skills/create-module/SKILL.md Outdated
Comment thread .claude/skills/create-module/SKILL.md Outdated
@coderabbitai

coderabbitai Bot commented Mar 16, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: d1153995-8a96-4214-9190-4e6ce585e759

📥 Commits

Reviewing files that changed from the base of the PR and between 5e59e6f and be96340.

📒 Files selected for processing (2)
  • .claude/skills/create-module/SKILL.md
  • .claude/skills/naming/SKILL.md

Walkthrough

Documentation updates to Claude skills modules: correcting header formatting in create-module skill documentation and updating a reference path from relative to absolute format, plus adding a mapping example to naming skill documentation.

Changes

Cohort / File(s) Summary
Documentation - create-module skill
.claude/skills/create-module/SKILL.md
Header level adjusted for "Config-driven enums" section; reference path updated from users.schema.js to modules/users/models/users.schema.js with reference label refined.
Documentation - naming skill
.claude/skills/naming/SKILL.md
Added documentation line with new mapping example: organizations.crud.service.js → crud.service.js.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/update-skills-naming-conventions
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

You can customize the tone of the review comments and chat replies.

Configure the tone_instructions setting to customize the tone of the review comments and chat replies. For example, you can set the tone to Act like a strict teacher, Act like a pirate and more.

- Use existing organizations module examples instead of hypothetical billing
- Fix file path reference to modules/users/models/users.schema.js
- Renumber orphan 4b as sub-section under step 4
@PierreBrisorgueil
PierreBrisorgueil merged commit d5a66e2 into master Mar 16, 2026
2 of 3 checks passed
@PierreBrisorgueil
PierreBrisorgueil deleted the chore/update-skills-naming-conventions branch March 16, 2026 11:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs Documentation only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants