firefly-conventions

Official

Apply Firefly conventions across your code.

Authorfireflyframework
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Standardizes coding practices across all Firefly Framework modules by enforcing naming conventions, package structures, reactive patterns, error handling, and build conventions to reduce cognitive load and onboarding time.

Core Features & Use Cases

  • Naming and packaging conventions across modules (kernel, web, cqrs, starter-*, utils, eda, etc.).
  • Reactive programming rules (WebFlux, Mono/Flux usage, non-blocking practices).
  • Uniform error handling hierarchy and exception usage.
  • Build and configuration conventions for consistent BOMs, profiles, and processors.
  • Real-world usage: teams migrating multiple services align to a single standard to reduce integration issues.

Quick Start

Adopt the Firefly conventions in new or existing modules to ensure consistent naming, packaging, reactive patterns, and error handling across the codebase.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: firefly-conventions
Download link: https://github.com/fireflyframework/fireflyframework-claude-skills/archive/main.zip#firefly-conventions

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.