docs-development

Document MC-ORG pipeline orchestration, database operations, and validation patterns.

Updated Jun 26, 2022
One-click install
npx skills add https://github.com/evengul/mc-org --skill docs-development
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-development
Source: https://github.com/evengul/mc-org/tree/main/.claude/skills/docs-development
Command: npx skills add https://github.com/evengul/mc-org --skill docs-development

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive reference for the core development patterns and best practices used within the MC-ORG project, ensuring consistency and efficiency in building new features.

Core Features & Use Cases

  • Pipeline Orchestration: Understand how to build sequential and parallel pipelines using handlePipeline and parallel.
  • Step Implementation: Learn to define custom steps using the Step interface, including object and class-based steps.
  • Database Operations: Master safe and efficient database interactions with SafeSQL and DatabaseSteps, including transaction management.
  • Validation Logic: Implement robust input validation using ValidationSteps and understand AppFailure and ValidationFailure types.
  • Critical Imports: Quickly find essential import statements for common development tasks.

Quick Start

Refer to the docs-development skill for examples on how to implement a new database transaction.

Frequently Asked Questions about docs-development

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

FAQPage Schema
How do I build sequential and parallel pipelines in Kotlin?

Custom step implementation in Kotlin uses the Step interface, supporting both object and class-based definitions. This structure allows you to encapsulate specific processing tasks and integrate them into broader pipeline workflows.

How do I handle atomic database transactions with SafeSQL?

SafeSQL database operations handle atomic transactions through DatabaseSteps. This pattern ensures safe database interactions, managing transaction states and preventing partial updates during execution failures.

How does validation logic work with AppFailure and ValidationFailure?

Validation logic uses ValidationSteps to check inputs and throws AppFailure or ValidationFailure types upon errors. This mechanism ensures robust error handling by clearly distinguishing validation issues from application-level failures.

Can I define custom steps using both objects and classes in Kotlin?

Custom step implementation in Kotlin uses the Step interface, supporting both object and class-based definitions. This structure allows you to encapsulate specific processing tasks and integrate them into broader pipeline workflows.

What is the best way to handle errors in pipeline orchestration?

Pipeline error handling uses AppFailure types to capture and manage exceptions during execution. This approach ensures consistent failure management across both sequential and parallel pipeline steps.