firefly-conventions

Document Firefly conventions for code organization, reactive patterns, and error handling.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/fireflyframework/fireflyframework-claude-skills --skill firefly-conventions
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: firefly-conventions
Source: https://github.com/fireflyframework/fireflyframework-claude-skills/tree/main/skills/firefly-conventions
Command: npx skills add https://github.com/fireflyframework/fireflyframework-claude-skills --skill firefly-conventions

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about firefly-conventions

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

FAQPage Schema
How do I standardize naming conventions and package structure across Firefly Framework modules?

Apply Firefly conventions to enforce uniform naming and package structure across kernel, web, cqrs, and starter modules. This standardizes code organization, reduces cognitive load, and ensures consistent reactive programming practices across your codebase.

What are the reactive programming rules for WebFlux Mono and Flux in Firefly modules?

Firefly conventions enforce strict WebFlux Mono and Flux usage with non-blocking practices across modules. Applying these reactive programming rules ensures consistent asynchronous data flow and prevents blocking calls in your codebase.

How do I set up a uniform error handling hierarchy for Java reactive microservices?

Establish a uniform error handling hierarchy by applying Firefly conventions for exception usage across modules. This standardizes error handling practices, ensuring consistent exception management and reducing integration issues across reactive services.

Can I use Firefly conventions to align multiple services migrating to a single code standard?

Yes, Firefly conventions align multiple services to a single standard during migration. Applying these conventions across modules reduces integration issues by enforcing consistent build profiles, BOMs, and configuration practices across your codebase.

What are the build and configuration conventions for consistent BOMs and profiles in Firefly?

Firefly build and configuration conventions enforce consistent BOMs, profiles, and processors across modules. Applying these standards ensures uniform build practices, reducing configuration drift and integration issues across multiple services.

When should I not use standardized build conventions for my existing Firefly modules?

Avoid applying standardized Firefly build conventions when existing modules require highly customized configurations or non-standard BOMs. These conventions enforce strict uniformity, which may conflict with specialized build profiles or unique project constraints.