crablet-conventions

Review code diffs against spring-crablet coding and design conventions.

1|1|Updated Oct 17, 2025
One-click install
npx skills add https://github.com/rodolfodpk/spring-crablet --skill crablet-conventions
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: crablet-conventions
Source: https://github.com/rodolfodpk/spring-crablet/tree/main/.claude/skills/crablet-conventions
Command: npx skills add https://github.com/rodolfodpk/spring-crablet --skill crablet-conventions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill simplifies the process of ensuring that code and Pull Requests comply with spring-crablet's strict code and design conventions, thereby fostering maintainable, aligned application structures.

Core Features & Use Cases

  • Review and Compliance: Offers an easy-to-use method for developers to review code diffs or entire files against the spring-crablet's standards.
  • Conventions Enforcing: Catches specific patterns such as the absence of fully-qualified names, the correct naming of event types, snake_case keys, etc., which might slip through standard linters.
  • Understanding the 'Why': Provides insights into why certain conventions exist to help developers appreciate and adhere to the established guidelines.

Quick Start

Check the compliance of your latest PR against the convention standards by using 'crablet-conventions -- review your_pull_request.md'.

Frequently Asked Questions about crablet-conventions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate code reviews for Spring Boot event-driven applications?

Automate code reviews for Spring Boot event-driven applications by checking submissions against strict design conventions, catching patterns like incorrect event typing and tag case that standard linters miss.

Why should I enforce design conventions like fully-qualified name removal in my code?

Enforce design conventions like fully-qualified name removal to foster maintainable, aligned application structures within Spring Boot projects and prevent non-compliant code from entering the main branch.

How do I check my pull request diff against coding standards?

Check your pull request diff against coding standards by running a single command to review your PR file, which scans the code and reports deviations from established guidelines.

Can I use this to review entire files instead of just PR diffs?

Yes, you can review entire files. The Skill supports checking both code diffs and full files against spring-crablet's coding and design standards to ensure comprehensive compliance.

Does this convention checker catch snake_case keys and event naming issues?

Yes, the convention checker catches specific patterns including snake_case keys, correct event type naming, and tag case, enforcing rules that might slip through standard linters.

What is the best way to understand why certain code conventions exist?

Understand why certain code conventions exist by reviewing the insights provided during the compliance check, which explains the reasoning behind established guidelines to help developers adhere to them.